Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rajatjindal/krew-release-bot
bot to bump version of plugin in krew-index on new releases
https://github.com/rajatjindal/krew-release-bot
bot github golang krew kubectl kubernetes release
Last synced: 18 days ago
JSON representation
bot to bump version of plugin in krew-index on new releases
- Host: GitHub
- URL: https://github.com/rajatjindal/krew-release-bot
- Owner: rajatjindal
- License: apache-2.0
- Created: 2019-11-30T03:30:04.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-03T13:46:34.000Z (3 months ago)
- Last Synced: 2024-10-22T03:33:28.052Z (23 days ago)
- Topics: bot, github, golang, krew, kubectl, kubernetes, release
- Language: Go
- Homepage:
- Size: 13.7 MB
- Stars: 47
- Watchers: 3
- Forks: 17
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://app.netlify.com/sites/angry-borg-f9dd47/deploys)
`krew-release-bot` is a bot that automates the update of plugin manifests in `krew-index` when a new version of your `kubectl` plugin is released.
If a release is marked as a 'prerelease' in github, it will not be released to the krew index.
To trigger `krew-release-bot` you can use a `github-action` which sends the event to the bot.
# 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](https://github.com/rajatjindal/kubectl-evict-pod) repo for an example.
- you could use https://rajatjindal.com/tools/krew-release-bot-helper/ for generating template for your plugin
- To setup the action, add the following snippet after the step that publishes the new release and assets:
```yaml
- name: Update new version in krew-index
uses: rajatjindal/[email protected]
```
Check out the `goreleaser` example below for details.
##### Example when using go-releaser
`/.github/workflows/release.yml`
```yaml
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@v4
with:
go-version: '1.20'
- 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.
# Examples using krew-release-bot in different ways
- [bash based plugins](https://github.com/ahmetb/kubectx/blob/master/.github/workflows/release.yml)
- [multiple plugins published from one repo](https://github.com/ahmetb/kubectx/blob/master/.github/workflows/release.yml)
- [circle-ci](examples/circleci.yml)
- [travis-ci](examples/travis.yml)
# Testing the template file
You can test the template file rendering before check-in to the repo by running following command
```bash
$ docker run -v /path/to/your/template-file.yaml:/tmp/template-file.yaml ghcr.io/rajatjindal/krew-release-bot:v0.0.46 \
krew-release-bot template --tag --template-file /tmp/template-file.yaml
```
# Inputs for the action
| Key | Default Value | Description |
| ------------------ | ---------------------- | ------------------------------------------------------------------------------------ |
| workdir | `env.GITHUB_WORKSPACE` | Overrides the GitHub workspace directory path |
| krew_template_file | `.krew.yaml` | The path to template file relative to $workdir. e.g. templates/misc/plugin-name.yaml |
# Limitations of krew-release-bot
- only works for repos hosted on github right now
- The first version of plugin has to be submitted manually, by plugin author, to the krew-index repo
# 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.