Skip to content

zendesk/k8s-role-change-guidance

Repository files navigation

k8s-role-change-guidance

Latest tag Tests

A custom Github Action for use on pull requests. The action:

  • looks for added / removed Kubernetes roles (under ./kubernetes)
  • if there are any such roles, then adds a comment (unless already there) to the pull request explaining how to merge and deploy safely
  • if there no such roles, then deletes any such comment

Inputs

See inputs in action.yml.

Output

This action has no outputs.

Usage of the Github action

---
name: Kubernetes Role Change Guidance
on:
  pull_request:
    types: [opened, synchronize, reopened]

jobs:
  k8s-role-change-guidance:
    runs-on: [ubuntu-latest]
    name: Kubernetes role change guidance
    steps:
      - uses: zendesk/checkout@...
      - uses: zendesk/k8s-role-change-guidance@VERSION
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}

where VERSION is the tag you wish you use, e.g. v0.1 (or a branch, or a commit hash). Check the top of this README for the latest tag, or consult the tags page for more.

About

A github action to provide guidance on how safely to handle k8s role additions / removals

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages