From 15af307b6106b35c04ab93a300ed0a3ed0a0720d Mon Sep 17 00:00:00 2001
From: Abishek PY <43115551+vj-abishek@users.noreply.github.com>
Date: Wed, 3 Mar 2021 16:15:10 +0530
Subject: [PATCH] feat: added documentation
Thanks, @Vyvy-vi for those changes
---
README.md | 48 +++++++++++++++++++++++++++++++++++-------------
1 file changed, 35 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
index f804f92..2403c8f 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,13 @@
-
-
Invite-on-label
-
-
- 
-
+# Invite-on-label workflow
-## Usage:
+
+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:
@@ -19,19 +20,40 @@ jobs:
- name: Invite on label
uses: vj-abigo/invite-on-label@v1.2
with:
- organization: EddieJaoudeCommunity
- label: invite me to the organisation
+ 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
+**_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 on the issue
+**_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`
-**NOTE:** create a [repository secret](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) 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](https://github.com/settings/tokens) with the scope of _`admin:org`_
+- 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.
+- In order for the workflow to work, you would need a PAT that gives admin access to the org.
+This can be generated in your account settings- `Settings > Developer Settings > Personal Access Tokens > Generate New Access Token`
+Give the following permissions to the token:
+
+
+
+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.
+
+### 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).