-
Notifications
You must be signed in to change notification settings - Fork 368
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add documentation about automating release using krew-release-bot #468
Conversation
Welcome @rajatjindal! |
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: rajatjindal The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Codecov Report
@@ Coverage Diff @@
## master #468 +/- ##
=======================================
Coverage 56.52% 56.52%
=======================================
Files 19 19
Lines 927 927
=======================================
Hits 524 524
Misses 350 350
Partials 53 53 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
First of all, thanks for pushing this forward @rajatjindal !
Before we merge this, let's get a common understanding about whether krew-release-bot
should be the recommended procedure for updates, as stated on your project landing page. I'd prefer to not have this statement there, because the real goal is to have PRs with regular changesets, so that the approver-bot can handle them. Also, it's not clear who recommends this.
docs/DEVELOPER_GUIDE.md
Outdated
### Automating the releasing of new version | ||
|
||
You can use Github Actions to publish new release of your Krew plugin. | ||
`krew-release-bot` is a github action to automatically bump the version in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
`krew-release-bot` is a github action to automatically bump the version in | |
`krew-release-bot` is a GitHub Action to automatically bump the version in |
Better be consistent with regards to capitalization. IMO, Action
is a name here and needs to have a capital letter too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
docs/DEVELOPER_GUIDE.md
Outdated
You can use Github Actions to publish new release of your Krew plugin. | ||
`krew-release-bot` is a github action to automatically bump the version in | ||
`krew-index` repo. | ||
Refer to the [documentation here](https://github.com/rajatjindal/krew-release-bot) for details. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Refer to the [documentation here](https://github.com/rajatjindal/krew-release-bot) for details. | |
Refer to the [krew-release-bot](https://github.com/rajatjindal/krew-release-bot) documentation for details. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
sorry for the confusion it has caused. My intention was not to show recommendation from krew team, rather that statement was added when krew-release-bot had two ways of doing PR. (webhook & github-action) and out of those two github-action was the recommended way of doing PR. I will remove that statement to avoid any further confusion. thanks for pointing out. |
docs/DEVELOPER_GUIDE.md
Outdated
You can use Github Actions to publish new release of your Krew plugin. | ||
`krew-release-bot` is a Github Action to automatically bump the version in | ||
`krew-index` repo. | ||
Refer to the [krew-release-bot](https://github.com/rajatjindal/krew-release-bot) for details. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Refer to the [krew-release-bot](https://github.com/rajatjindal/krew-release-bot) for details. | |
Refer to the [krew-release-bot](https://github.com/rajatjindal/krew-release-bot) documentation for details. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
😃 no worries. I'm open to also make this a krew-recommended upgrade method for version bumps, but it's a little early for that. Let's first to gather some more experience. |
@corneliusweig tbh this is the "polished" experience compared to what it was before, and I suspect it's unlikely to change dramatically. I thought about image coming from a personal repo, but I think even that's OK for now. We just need to keep it static, as it works pretty decently at the moment. |
As long as no credentials or access tokens are passed to the action, the image can be hosted anywhere. @rajatjindal when you made your final change, let's merge this! |
Rather than the hosting of the image, the problem is to keep the API between container Since we don't use |
Hi @corneliusweig/@ahmetb thanks for all the feedback to get the wording right. I think I've addressed all the review comments now. If there is anything else that needs to be changed, I will be more than happy to do so. thanks |
Accidentally manually merged but |
No description provided.