Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vj-abigo/invite-on-label
Automate organization invitation based on the label (used by EddieHub org)
https://github.com/vj-abigo/invite-on-label
actions automate-organization-invite github github-actions invite-users organization-tool
Last synced: 7 days ago
JSON representation
Automate organization invitation based on the label (used by EddieHub org)
- Host: GitHub
- URL: https://github.com/vj-abigo/invite-on-label
- Owner: vj-abigo
- License: mit
- Created: 2021-01-13T11:20:25.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-08-24T20:02:18.000Z (about 1 year ago)
- Last Synced: 2024-11-04T14:43:08.416Z (11 days ago)
- Topics: actions, automate-organization-invite, github, github-actions, invite-users, organization-tool
- Language: JavaScript
- Homepage:
- Size: 4.35 MB
- Stars: 19
- Watchers: 2
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Invite-on-label workflow
This action allows you to auto-invite people to your org. after they open an issue, with a specific label.
### How to use
- Go to your repository
- Create a folder named `.github` and create a `workflows` folder inside it if it doesn't exist.
- Create a new file named `invitation.yml` with the following contents inside the `workflows` folder:
```yml
on:
issues:
types: [labeled]
jobs:
automate_invite:
runs-on: ubuntu-latest
steps:
- name: Invite on label
uses: vj-abigo/[email protected]
with:
organization: GitHub-Org
label: invite me to the organization
repo-token: ${{ secrets.GITHUB_TOKEN }}
comment: 'Welcome to the Org.'
env:
INVITE_TOKEN: ${{ secrets.INVITE_TOKEN }}
```
- Replace the `organization` name to put in name of your org, replace the `label` with name of the label with which you want this action to be triggered.
- Replace `comment` with the message you want the github-actions bot to send after an invite is sent.
- **NOTE:** create a [personal access token](https://github.com/settings/tokens/new) called _`INVITE_TOKEN`_ _(or give it another name, but don't forget to change it in the workflow)_ with the scope of _`admin:org`_ and set the expiration date as _`No expiration`_ _(If you don't want to regenerate token again)_
- Copy the generated token and navigate to your org's secrets(`Organization Settings > Secrets`) and create a `New Organization Secret` with the Name as `INVITE_TOKEN` and the value as the token that you copied in the previous step.
`https://github.com/organizations/*your-org-name*/settings/secrets/actions`
- You don't worry about the `GITHUB_TOKEN`, It will be given by GitHub
### Note:
**_organization_** - _(required)_ Name of the organization to which you would like to invite your contributors
**_label_** - _(required)_ Name of the label
**_comment_** - _(optional)_ A comment which will be posted by github-actions bot after invite is sent.
> Default comment: `Invitation sent for the GitHub Organisation. Welcome to the community`
**_existingMemberMessage_** _(optional)_ Message for existing organisation members
> Default Message: `You are already a member of our Organisation.`
### Examples
- [EddieHub invitation Workflow](https://github.com/EddieHubCommunity/support/blob/main/.github/workflows/invitation.yml)
### Contributing
Please see [`CONTRIBUTING.md`](./CONTRIBUTING.md) for getting started with the contribution. Make sure that you follow [`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md) while contributing and engaging in the discussions. **When contributing, please first discuss the change you wish to make via an issue on this repository before making the actual change.**
#### ToDo-
- [ ] Better Docs
- [ ] Fix bugs, if any
#### Bugs-
If you feel any difficulty in usage or notice a bug, don't forget to [open a new issue](https://github.com/vj-abigo/invite-on-label/issues/new).
### Contributors
Made with [contributors-img](https://contrib.rocks).