Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/actionsdesk/actions-app-repository-management
Manage repository access for GitHub Apps using GitHub Actions and issue templates
https://github.com/actionsdesk/actions-app-repository-management
Last synced: about 6 hours ago
JSON representation
Manage repository access for GitHub Apps using GitHub Actions and issue templates
- Host: GitHub
- URL: https://github.com/actionsdesk/actions-app-repository-management
- Owner: ActionsDesk
- License: mit
- Created: 2021-02-04T09:52:45.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-07T23:38:31.000Z (almost 2 years ago)
- Last Synced: 2023-03-03T20:57:33.306Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 1.21 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# GitHub App Repository Management
This repository is a template for Services customers to setup an automation for onboarding
GitHub app repos into installed GitHub apps with the `selected` option for repository selection.
> DISCLAIMER: Since this is considered a template to be used with customers, opening the issues here will not grant any
access in the GitHub organization
## Available GitHub Applications
This list is autogenerated using the script from [app-list-generator](./app-list-generator)
| ID | Name | Description | Owner | Permissions |
| ---------------------- | ---------------------- | ---------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| test-app | test-app | This is a description for the test we are performing | hubber | - contents (write)
- metadata (read)
- environments (write)
- administration (write)
- organization_packages (write)
|
## Instructions
You can request that a repository is added to, or removed from, one of the approved GitHub Applications by [raising an issue](https://github.com/github/actions-app-repository-management/issues) in this repository.
There are issue templates that you must use to get the action completed and you should ensure that you adhere to the following suggestions:
- Do not change the title of the issue.
- Any changes to the title will mean the issue is closed without any further action.
- The issue content should be valid yaml.
- If the content does not parse correctly then the ticket will be close without any further action.
- You may supply multiple repositories and GitHub Application names.
- Valid repositories will be added to all valid GitHub Application names.
- Once an issue has been opened it will be processed based on the initial data entered.
- Do not try to change the issue after raised as it will not be actioned.
- Once complete the issue will be locked and closed.
- Any comments added to an issue will be ignored.
## How to use this repository
- Clone this repository and change the documentation to fit the customer needs
- Change the content of the file `githubapps.json` to contain the GitHub apps that you want to manage
- Edit the templates in [ISSUE_TEMPLATE](./.github/ISSUE_TEMPLATE) to fit the policies required
- Add the secret `PAT` to the GitHub actions secret with org:admin scope
- Test that the workflows are workign as expected
> This repository requires `PAT` machine account authentication since the repository addition/deletion from the GitHub apps
> is not allowed with GitHub Apps scopes.
### Single Repository To GitHub Application example content
```
Repository Name:
- group-repositoryname
GitHub Application:
- github-app-name
```
### Multiple Repository To Multiple GitHub Applications example content
```
Repository Name:
- group-repositoryone
- group-repositorytwo
- newgroup-repositorytwo
GitHub Application:
- github-app-name
- github-app-name-two
```
## Test the app
The app contains tests that can be run with the following commands under `actions/app-management`:
```bash
npm install
npm run test
```