Tag a user or a team in an issue comment
Sometimes you want to tag a team or multiple persons when an issue (or something else) is created. This action will help you do that by tagging them in an issue by making a comment that tags them.
Requirements:
A GitHub App installed on the repository/organization that the GitHub Actions Workflow will execute from. The GitHub Apps minimally should have the following permissions:
- Read & write access to Issues
- Read-only access to Members
- Read-only access to Administration (Only applicable for GitHub Enterprise Server) A method to retrieve an access token from the App, a good example for an action would be this action.
- uses: devops-actions/[email protected]
with:
team: < insert team or user name >
issue: ${{ github.event.issue.number }}
owner: ${{ github.repository_owner }}
repo: ${{ github.repository }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}on:
issues:
types: [opened]
jobs:
tag-a-user:
runs-on: ubuntu-latest
steps:
- uses: devops-actions/[email protected]
name: Tag a user or team in an issue comment
with:
issue: ${{ github.event.issue.number }}
team: < insert team or user name >
owner: ${{ github.repository_owner }}
repo: ${{ github.repository }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}If you need to tag an internal team @<org name>/team or user, then you need to send in an Access Token that has the rights to do so: the normal GITHUB_TOKEN doesn't have access outside the current repository, which also means it cannot see the users in the organization.
If you are using a GitHub App for creating the access token, you need to give the App the following scope:
- Organization permissions - Members: Read only
