e1b4e266bc
* feat: support yml or yaml (#427) test: support yml or yaml chore: lint * Fix getting permissions for the contributors who are a part of the team (#424) * Fix getActorPermission to handle team-based permissions * Use 'user.permissions' object to return permission * Add RepoPermission type * Make new build * feat: update runtime to node 24 * fix: eslint-plugin dep * fix: remove unused type * docs: update whats new --------- Co-authored-by: Patrick Lee Scott <[email protected]> Co-authored-by: Volodymyr Zotov <[email protected]>
318 lines
11 KiB
Markdown
318 lines
11 KiB
Markdown
# Examples
|
|
|
|
- [Use case: Execute command using a specific repository branch](#use-case-execute-command-using-a-specific-repository-branch)
|
|
- [pytest](#pytest)
|
|
- [Use case: Execute command to modify a pull request branch](#use-case-execute-command-to-modify-a-pull-request-branch)
|
|
- [rebase](#rebase)
|
|
- [black](#black)
|
|
- [Help command](#help-command)
|
|
|
|
## Use case: Execute command using a specific repository branch
|
|
|
|
This is a pattern for a slash command where a named argument specifies the branch to checkout. If the named argument is missing it defaults to `main`. For example, the following command will cause the command workflow to checkout the `develop` branch of the repository where the command was dispatched from. After the branch has been checked out in the command workflow, scripts, tools or actions may be executed against it.
|
|
|
|
```
|
|
/do-something branch=develop
|
|
```
|
|
|
|
In the following command workflow, `PAT` is a `repo` scoped [Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
|
|
|
|
```yml
|
|
name: do-something-command
|
|
on:
|
|
repository_dispatch:
|
|
types: [do-something-command]
|
|
jobs:
|
|
doSomething:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
# Get the branch name
|
|
- name: Get the target branch name
|
|
id: vars
|
|
run: |
|
|
branch=${{ github.event.client_payload.slash_command.args.named.branch }}
|
|
if [[ -z "$branch" ]]; then branch="main"; fi
|
|
echo "branch=$branch" >> $GITHUB_OUTPUT
|
|
|
|
# Checkout the branch to test
|
|
- uses: actions/checkout@v3
|
|
with:
|
|
token: ${{ secrets.PAT }}
|
|
repository: ${{ github.event.client_payload.github.payload.repository.full_name }}
|
|
ref: ${{ steps.vars.outputs.branch }}
|
|
|
|
# Execute scripts, tools or actions
|
|
- name: Do something
|
|
run: |
|
|
# Execute a script, tool or action here
|
|
#
|
|
echo "Do something"
|
|
|
|
# Add reaction to the comment
|
|
- name: Add reaction
|
|
uses: peter-evans/create-or-update-comment@v5
|
|
with:
|
|
token: ${{ secrets.PAT }}
|
|
repository: ${{ github.event.client_payload.github.payload.repository.full_name }}
|
|
comment-id: ${{ github.event.client_payload.github.payload.comment.id }}
|
|
reactions: hooray
|
|
```
|
|
|
|
### pytest
|
|
|
|
This is a real example that uses this pattern to execute the Python test tool [pytest](https://github.com/pytest-dev/pytest/) against a specific branch.
|
|
|
|
```
|
|
/pytest branch=develop -v -s
|
|
```
|
|
|
|
In the following command workflow, note how the unnamed arguments are passed to the `pytest` tool with the property `args.unnamed.all`.
|
|
|
|
```yml
|
|
name: pytest
|
|
on:
|
|
repository_dispatch:
|
|
types: [pytest-command]
|
|
jobs:
|
|
pytest:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
# Get the branch name
|
|
- name: Get the target branch name
|
|
id: vars
|
|
run: |
|
|
branch=${{ github.event.client_payload.slash_command.args.named.branch }}
|
|
if [[ -z "$branch" ]]; then branch="main"; fi
|
|
echo "branch=$branch" >> $GITHUB_OUTPUT
|
|
|
|
# Checkout the branch to test
|
|
- uses: actions/checkout@v3
|
|
with:
|
|
token: ${{ secrets.PAT }}
|
|
repository: ${{ github.event.client_payload.github.payload.repository.full_name }}
|
|
ref: ${{ steps.vars.outputs.branch }}
|
|
|
|
# Setup Python environment
|
|
- uses: actions/setup-python@v3
|
|
|
|
# Install pytest
|
|
- name: Install pytest
|
|
run: |
|
|
pip install -U pytest
|
|
pytest --version
|
|
|
|
# Install requirements
|
|
- name: Install requirements
|
|
run: pip install -r requirements.txt
|
|
|
|
# Execute pytest
|
|
- name: Execute pytest
|
|
run: pytest ${{ github.event.client_payload.slash_command.args.unnamed.all }}
|
|
|
|
# Add reaction to the comment
|
|
- name: Add reaction
|
|
uses: peter-evans/create-or-update-comment@v5
|
|
with:
|
|
token: ${{ secrets.PAT }}
|
|
repository: ${{ github.event.client_payload.github.payload.repository.full_name }}
|
|
comment-id: ${{ github.event.client_payload.github.payload.comment.id }}
|
|
reactions: hooray
|
|
```
|
|
|
|
## Use case: Execute command to modify a pull request branch
|
|
|
|
This is a pattern for a slash command used in pull request comments. It checks out the pull request branch and allows further scripts, tools and action steps to modify it.
|
|
|
|
```
|
|
/fix-pr
|
|
```
|
|
|
|
In the dispatch configuration for this command pattern, `issue-type` should be set to `pull-request`. This will prevent it from being dispatched from regular issue comments where it will fail.
|
|
|
|
In the following command workflow, `PAT` is a `repo` scoped [Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
|
|
|
|
```yml
|
|
name: fix-pr-command
|
|
on:
|
|
repository_dispatch:
|
|
types: [fix-pr-command]
|
|
jobs:
|
|
fixPr:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
# Checkout the pull request branch
|
|
- uses: actions/checkout@v3
|
|
with:
|
|
token: ${{ secrets.PAT }}
|
|
repository: ${{ github.event.client_payload.pull_request.head.repo.full_name }}
|
|
ref: ${{ github.event.client_payload.pull_request.head.ref }}
|
|
|
|
# Commit changes to the PR branch
|
|
- name: Commit changes to the PR branch
|
|
run: |
|
|
# Make changes to commit here
|
|
#
|
|
git config --global user.name 'actions-bot'
|
|
git config --global user.email '[email protected]'
|
|
git commit -am "[fix-pr-command] fixes"
|
|
git push
|
|
|
|
- name: Add reaction
|
|
uses: peter-evans/create-or-update-comment@v5
|
|
with:
|
|
token: ${{ secrets.PAT }}
|
|
repository: ${{ github.event.client_payload.github.payload.repository.full_name }}
|
|
comment-id: ${{ github.event.client_payload.github.payload.comment.id }}
|
|
reactions: hooray
|
|
```
|
|
|
|
### rebase
|
|
|
|
This rebase command is a working example and demonstrates a using slash command to modify a pull request.
|
|
|
|
```
|
|
/rebase
|
|
```
|
|
|
|
In the following command workflow, note how the pull request `rebaseable` context property is checked to see whether or not GitHub has determined a safe rebase is possible.
|
|
|
|
```yml
|
|
name: rebase-command
|
|
on:
|
|
repository_dispatch:
|
|
types: [rebase-command]
|
|
jobs:
|
|
rebase:
|
|
if: github.event.client_payload.pull_request.rebaseable == true
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout pull request
|
|
uses: actions/checkout@v3
|
|
with:
|
|
token: ${{ secrets.PAT }}
|
|
repository: ${{ github.event.client_payload.pull_request.head.repo.full_name }}
|
|
ref: ${{ github.event.client_payload.pull_request.head.ref }}
|
|
fetch-depth: 0
|
|
|
|
- name: Rebase
|
|
run: |
|
|
git config --global user.name '${{ github.event.client_payload.github.actor }}'
|
|
git config --global user.email '${{ github.event.client_payload.github.actor }}@users.noreply.github.com'
|
|
git remote add base https://x-access-token:${{ secrets.PAT }}@github.com/${{ github.event.client_payload.pull_request.base.repo.full_name }}.git
|
|
git fetch base ${{ github.event.client_payload.pull_request.base.ref }}
|
|
git rebase base/${{ github.event.client_payload.pull_request.base.ref }}
|
|
git push --force-with-lease
|
|
|
|
- name: Update comment
|
|
uses: peter-evans/create-or-update-comment@v5
|
|
with:
|
|
token: ${{ secrets.PAT }}
|
|
repository: ${{ github.event.client_payload.github.payload.repository.full_name }}
|
|
comment-id: ${{ github.event.client_payload.github.payload.comment.id }}
|
|
body: |
|
|
>Pull request successfully rebased
|
|
reactions: hooray
|
|
|
|
notRebaseable:
|
|
if: github.event.client_payload.pull_request.rebaseable != true
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Update comment
|
|
uses: peter-evans/create-or-update-comment@v5
|
|
with:
|
|
token: ${{ secrets.PAT }}
|
|
repository: ${{ github.event.client_payload.github.payload.repository.full_name }}
|
|
comment-id: ${{ github.event.client_payload.github.payload.comment.id }}
|
|
body: |
|
|
>Pull request is not rebaseable
|
|
reactions: hooray
|
|
```
|
|
|
|
### black
|
|
|
|
In this real example, a pull request is modified by formatting Python code using [Black](https://github.com/psf/black).
|
|
|
|
```
|
|
/black
|
|
```
|
|
|
|
In the following command workflow, note how a step `if` condition checks to see if anything should be committed.
|
|
|
|
```yml
|
|
name: black-command
|
|
on:
|
|
repository_dispatch:
|
|
types: [black-command]
|
|
jobs:
|
|
black:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
# Checkout the pull request branch
|
|
- uses: actions/checkout@v3
|
|
with:
|
|
token: ${{ secrets.PAT }}
|
|
repository: ${{ github.event.client_payload.pull_request.head.repo.full_name }}
|
|
ref: ${{ github.event.client_payload.pull_request.head.ref }}
|
|
|
|
# Setup Python environment
|
|
- uses: actions/setup-python@v3
|
|
|
|
# Install black
|
|
- name: Install black
|
|
run: pip install black
|
|
|
|
# Execute black in check mode
|
|
- name: Black
|
|
id: black
|
|
run: |
|
|
format=$(black --check --quiet . || echo "true")
|
|
echo "format=$format" >> $GITHUB_OUTPUT
|
|
|
|
# Execute black and commit the change to the PR branch
|
|
- name: Commit to the PR branch
|
|
if: steps.black.outputs.format == 'true'
|
|
run: |
|
|
black .
|
|
git config --global user.name 'actions-bot'
|
|
git config --global user.email '[email protected]'
|
|
git commit -am "[black-command] fixes"
|
|
git push
|
|
|
|
- name: Add reaction
|
|
uses: peter-evans/create-or-update-comment@v5
|
|
with:
|
|
token: ${{ secrets.PAT }}
|
|
repository: ${{ github.event.client_payload.github.payload.repository.full_name }}
|
|
comment-id: ${{ github.event.client_payload.github.payload.comment.id }}
|
|
reactions: hooray
|
|
```
|
|
|
|
## Help command
|
|
|
|
The following is an example command workflow to return details of available commands when a user issues the `/help` command.
|
|
|
|
```yml
|
|
name: help-command
|
|
on:
|
|
repository_dispatch:
|
|
types: [help-command]
|
|
jobs:
|
|
help:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Update comment
|
|
uses: peter-evans/create-or-update-comment@v5
|
|
with:
|
|
token: ${{ secrets.ACTIONS_BOT_TOKEN }}
|
|
repository: ${{ github.event.client_payload.github.payload.repository.full_name }}
|
|
comment-id: ${{ github.event.client_payload.github.payload.comment.id }}
|
|
body: |
|
|
> Command | Description
|
|
> --- | ---
|
|
> /hello-world | Receive a greeting from the world
|
|
> /ping [\<args\> ...] | Echos back a list of arguments
|
|
> /hello-world-local | Receive a greeting from the world (local execution)
|
|
> /ping-local [\<args\> ...] | Echos back a list of arguments (local execution)
|
|
reactions: hooray
|
|
```
|