This action allows you to auto-invite people to your org. after they open an issue, with a specific label.
- Go to your repository
- Create a folder named
.github
and create aworkflows
folder inside it if it doesn't exist. - Create a new file named
invitation.yml
with the following contents inside theworkflows
folder:
on:
issues:
types: [labeled]
jobs:
automate_invite:
runs-on: ubuntu-latest
steps:
- name: Invite on label
uses: vj-abigo/invite-on-label@v1.2
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 }}
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
- Replace the
organization
name to put in name of your org, replace thelabel
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 repository secret called
INVITE_TOKEN
(or give it another name, but don't forget to change it in the workflow) and as a value provide a GitHub personal access token with the scope ofadmin:org
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.
- You don't worry about the
GITHUB_TOKEN
, It will be given by GitHub
Please see CONTRIBUTING.md
for getting started with the contribution. Make sure that you follow 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.
- Better Docs
- Fix bugs, if any
If you feel any difficulty in usage or notice a bug, don't forget to open a new issue.