https://github.com/ansys/ansys-all-members
Repository for updating the ansys/all-members team automatically
https://github.com/ansys/ansys-all-members
Last synced: about 1 month ago
JSON representation
Repository for updating the ansys/all-members team automatically
- Host: GitHub
- URL: https://github.com/ansys/ansys-all-members
- Owner: ansys
- License: mit
- Created: 2022-05-27T06:38:54.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-18T10:42:08.000Z (6 months ago)
- Last Synced: 2024-11-18T11:58:06.332Z (6 months ago)
- Language: Python
- Homepage:
- Size: 31.3 KB
- Stars: 2
- Watchers: 10
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# Ansys all-members team
[](https://www.ansys.com/)
[](https://www.python.org/)
[](https://github.com/ansys/ansys-all-members/actions/workflows/team_update.yml)
[](https://opensource.org/licenses/MIT)
[](https://github.com/psf/black)
Repository for updating the ansys/all-members team automatically.
## Table of contents
- [Ansys all-members team](#ansys-all-members-team)
- [Table of contents](#table-of-contents)
- [Introduction](#introduction)
- [How does it work?](#how-does-it-work)
- [Requirements](#requirements)
## Introduction
GitHub organizations do not provide an off-the-shelf capability of creating
and maintaining up-to-date an *all-members* team. The goal of the ``update_team.py`` script
in this repository is to:
* Provided an org and an *all-members* team (i.e. ``@/all-members``), update its
members on the execution of this script.
* Provide the capability to automate the update of the members using GitHub Actions.
Feel free to fork this repository for your own application. You are also welcome to help
contribute to it in any possible way! Please submit an issue with any proposal you may have.
## How does it work?
This repository basically contains a simple Python script ``update_team.py``. Within this
script, there are two main variables which a user must take into account:
* ``MY_PAT``: this variable will basically include your personal authentication token in order
to interact with GitHub (using [PyGitHub](https://github.com/PyGithub/PyGithub)). You can also
make use of the automated mechanism, by which the script will search for an environment variable
named ``TOKEN`` which should contain your PAT.
* ``MY_ORG``: the organization whose team *all-members* we want to update.
In order to run it, simply modify these values and run:
```bash
python update_team.py
```
Bear in mind that this specific version of the script has already set up the ``MY_ORG`` variable
to ``ansys``, since it is the organization for which this repository is oriented.
Furthermore, this repository has a GitHub Actions workflow to automate the update of the team
members on a regular basis (since it has an ``on.schedule`` argument). If you want to make use of
this capability take into account that a PAT must be stored as a repository secret. Check the
[workflow file](https://github.com/ansys/ansys-all-members/blob/main/.github/workflows/team_update.yml)
for further details.
## Requirements
In order to run the previous script, one only needs to install ``pygithub``. In order to ease the
user its installation, we have created a requirements file: ``requirements.txt``. You can install
the latest version of the package by doing as follows with the ``pip`` package manager:
```bash
pip install -r requirements.txt
```