github-workflow-as-kube

Commands

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	/unhold	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
ReTest	/retest	No OP	rerun all the failed tests, use /retest all to rerun all tests

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.

How To Use

To use the workflow, you have to:

• Provide a OWNERS file, only the approvers have the privilege to tag /approve or /approve cancel
• Create a class Personal Access Token with one user (you can choose to use Fine-grained tokens as well), the user better to act as a robot in the repo, with the following permissions:
  • repo (Full control of private repositories)
  • workflow (Update GitHub Action workflow files)
  • write:packages (Write access to packages)
  • admin:org (Full control of orgs and teams, read and write org projects, read org hooks, and read org custom properties)
  • admin:repo_hook (Full control of repository hooks)
  • admin:org_hook (Full control of organization hooks)
  • notifications (Read and write access to notifications)
  • write:discussion (Write access to discussions)
  • project (Read and write access to projects)
• Create a org-level secret under Security->Secrets and variables->Actions->Organization secrets, it should be named of AGENT_TOKEN.
• Add the token owner, the robot to the repo's Collaborators and teams with Write role, under the Direct access section.
• 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/.

That's it, now you can use the commands to manage your PRs.

Other workflows

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-e2e primitives and do not edit the workflow name.

Roadmap

• Dispatch reviewers
• PR review by AI agent.
• PR size detecting support