invite-on-label

KO | EN

gitlite — search

#javascript #css #python #golang #html #html5 #php #css3 #android #blog #java #react

invite-on-label

★ 25 Open GitHub ↗

Automate GitHub org invites based on issue labels (as used by EddieHub)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 🚀 Invite-on-Label GitHub Action

Automatically invite users to your **GitHub organization** when they open an issue with a specific label.

![Invite bot message screenshot](https://user-images.githubusercontent.com/62864373/109786137-dc3b1280-7c32-11eb-9f10-e0e8ed936d2e.png)

---

## 📦 Features

- ✅ Auto-invites users to your GitHub org on issue label
- 💬 Sends a welcome comment
- 🔒 Uses GitHub Actions securely with secrets

---

## 🛠️ Setup Instructions

### 1. Create Workflow File

Inside your repository:

```bash
mkdir -p .github/workflows
touch .github/workflows/invitation.yml
```

Paste the following into `.github/workflows/invitation.yml`:

```yaml
on:
  issues:
    types: [labeled]

jobs:
  automate_invite:
    runs-on: ubuntu-latest
    steps:
      - name: Invite on label
        uses: vj-abigo/invite-on-label@v1.4
        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:
> - `organization`: your GitHub org name
> - `label`: the label that will trigger the invite
> - `comment`: optional custom welcome message

---

### 2. Generate and Add Secrets

1. **Create a Personal Access Token** with `admin:org` scope  
   👉 [Generate Token](https://github.com/settings/tokens/new)

> 🔒 Set expiration to **"No expiration"** if you don't want to regenerate it later.

![Token scope: admin:org](https://user-images.githubusercontent.com/43115551/109795252-b450ac80-7c3c-11eb-8de7-5dc5d600f82e.png)

2. Go to your **Org Settings > Secrets**:  
   [`https://github.com/organizations/YOUR-ORG/settings/secrets/actions`](https://github.com/organizations/YOUR-ORG/settings/secrets/actions)

3. Add a **New Organization Secret**:
   - Name: `INVITE_TOKEN`
   - Value: *paste the token you copied*

> ✅ `GITHUB_TOKEN` is auto-generated by GitHub – no setup needed.

---

## ⚙️ Configuration Options

| Option                  | Required | Description                                                |
|-------------------------|----------|------------------------------------------------------------|
| `organization`          | ✅        | Your GitHub organization name                              |
| `label`                 | ✅        | The label that will trigger the invite action              |
| `comment`               | ⭕        | A custom message posted after the invite is sent           |
| `existingMemberMessage` | ⭕        | Message shown if the user is already a member              |

### 💬 Default Messages

- `comment`:  
  `"Invitation sent for the GitHub Organisation. Welcome to the community!"`

- `existingMemberMessage`:  
  `"You are already a member of our Organisation."`

---

## 📚 Example

Take a look at this working example:  
🔗 [EddieHubCommunity/support – invitation.yml](https://github.com/EddieHubCommunity/support/blob/main/.github/workflows/invitation.yml)

---

## 🤝 Contributing

- Read our [`CONTRIBUTING.md`](./CONTRIBUTING.md)
- Follow the [`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md)
- Open an issue to discuss changes before submitting a PR

---

## 🐞 Found a Bug?

Please [open an issue](https://github.com/vj-abigo/invite-on-label/issues/new) if something isn’t working as expected.

---

## 👥 Contributors

Thanks to everyone who has contributed!

_Made with [contrib.rocks](https://contrib.rocks)_

invite-on-label

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README