CodeX: PR Checks
ActionsGitHub Action for basic pull request hygiene:
- checks that a PR has a non-empty description
- checks that a PR is linked to an open issue
By default the action uses the built-in GITHUB_TOKEN.
For full draft/ready automation you may optionally pass a personal access token through the token input.
| Name | Required | Default | Description |
|---|---|---|---|
check |
no | description |
Which check to run: description, linked-issue, both |
mode |
no | comment |
Behavior: comment, strict, draft |
token |
no | empty | Optional token with extended permissions for PR mutations |
name: Check PR Description
on:
pull_request:
types: [opened, edited, synchronize]
permissions:
pull-requests: write
issues: write
contents: write
jobs:
check-description:
runs-on: ubuntu-latest
steps:
- uses: codex-team/action-pr-assistant@master
with:
check: description
mode: strictname: Check Linked Issue
on:
pull_request:
types: [opened, edited, synchronize]
permissions:
pull-requests: write
issues: write
contents: write
jobs:
check-linked-issue:
runs-on: ubuntu-latest
steps:
- uses: codex-team/action-pr-assistant@master
with:
check: linked-issue
mode: commentname: PR Hygiene
on:
pull_request:
types: [opened, edited, synchronize]
permissions:
pull-requests: write
issues: write
contents: write
jobs:
pr-hygiene:
runs-on: ubuntu-latest
steps:
- uses: codex-team/action-pr-assistant@master
with:
check: both
mode: commentMIT
CodeX: PR Checks is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
CodeX: PR Checks is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.