This workflow following Kubernetes habits, offering commands:
| Name | Add | Remove | Note |
|---|---|---|---|
| Good First Issue | /good-first-issue | /remove-good-first-issue | |
| Help | /help | /remove-help | |
| LGTM | /lgtm | /lgtm cancel | |
| Approve | /approve | /approve cancel | Only approvers have the privilege |
| Hold | /hold | /hold cancel | PR will not be merged once hold |
| Category | /kind feature | /remove-kind feature | Support kinds: feature, cleanup, bug, documentation and so on... |
| Assignment | /assign @somebody | /unassign @somebody | When @nobody, will assign/unassign to the commenter |
| Review Request | /cc @somebody | /uncc @somebody | When @nobody, will cc/uncc the commenter |
| Priority | /priority backlog | /remove-priority backlog | Support priorities: important-critical-urgent, important-soon, important-longterm, backlog, awaiting-more-evidence |
| Title | /retitle title_name | No OP | |
| Lifecycle | /reopen | /close | Authors and collaborators on the repository can trigger this command |
| Milestone | /milestone v0.0.1 | /milestone clear | Create the milestone labels manually in advance |
| Triage | /triage needs-information | /triage accepted | triage accepted will remove the needs-triage label |
| WIP | /wip | /wip cancel | |
| API Change | /kind api-change | /remove-kind api-change |
NOTE: PR will be auto-merged once have lgtm, approved and no do-not-merge/* labels and all the workflow checks are passed like the ci tests.
To use the workflow, you have to:
- Provide a OWNERS file, only the approvers have the privilege to tag
/approveor/approve cancel - Provide a github secret with the name of
AGENT_TOKEN, it should have right permissions, like owning the privilege to create labels, which is required below. - Add the token owner to the repo's
Collaborators and teamswith written role. - Add the init-workflow to your project under the path of
.github/workflows/, then run the workflow manually, which will help you finish the setup, like creating necessary labels. - Add the workflow to your project under the path of
.github/workflows/.
Then it should work now.
We support other workflows as well, you can select as your needed:
- Golang ci workflow: running golang ci, golang tests. You should provide
make test,make test-integration,make test-e2eprimitives.
- Dispatch reviewers
- PR review by AI agent.
- PR size detecting support