corneliusweig / krew-release-bot

bot to bump version of plugin in krew-index on new releases

krew-release-bot is a bot that automates the update of krew-index on the release of new version of your krew (or kubectl) plugin.

You can use github-action that sends the event to the bot. This is the recommended way of publishing new release of your plugin.

Basic Setup

• Make sure you have enabled github actions for your repo
• Add a .krew.yaml template file at the root of your repo. Refer to kubectl-evict-pod repo for an example.
• Setup the action to be triggered on pushing of new tag, after the action that publishes the new release with assets. See goreleaser examples below.

Example when using go-releaser

<your-git-root>/.github/workflows/release.yml

name: release
on:
  push:
    tags:
    - 'v*.*.*'
jobs:
  goreleaser:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@master
    - name: Setup Go
      uses: actions/setup-go@v1
      with:
        go-version: 1.13
    - name: GoReleaser
      uses: goreleaser/goreleaser-action@v1
      with:
        version: latest
        args: release --rm-dist
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    - name: Update new version in krew-index
      uses: rajatjindal/[email protected]

** You can also customize the release assets names, platforms for which build is done using .goreleaser.yml file in root of your git repo.

Limitations of krew-release-bot

• only works for repos hosted on github right now
• only supports one plugin per git repo right now
• The first version of plugin has to be submitted manually, by plugin author, to the krew-index repo
• The homepage in the plugin spec in krew-index is used to establish ownership. The repo from which the release is published should be the homepage of the plugin in already released plugin-spec.

Kubernetes CLA

krew-release-bot is just a service to open PR on your behalf to release a new version of the krew-plugin. Your CLA agreement (that you did when submitting the new plugin to krew-index) is still applicable on these PR's.