Skip to content
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

Merged
merged 5 commits into from
Jan 25, 2020

Conversation

rajatjindal
Copy link
Contributor

No description provided.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 18, 2020
@k8s-ci-robot
Copy link
Contributor

Welcome @rajatjindal!

It looks like this is your first PR to kubernetes-sigs/krew 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/krew has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jan 18, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: rajatjindal
To complete the pull request process, please assign soltysh
You can assign the PR to them by writing /assign @soltysh in a comment when ready.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@codecov-io
Copy link

codecov-io commented Jan 18, 2020

Codecov Report

Merging #468 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c32dc34...ef5b2ea. Read the comment docs.

docs/DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
docs/DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
docs/DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
docs/DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
docs/DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
Copy link
Contributor

@corneliusweig corneliusweig left a 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 Show resolved Hide resolved
### 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@rajatjindal
Copy link
Contributor Author

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.

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.

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.

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@corneliusweig
Copy link
Contributor

😃 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.

@ahmetb
Copy link
Member

ahmetb commented Jan 21, 2020

@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.

@corneliusweig
Copy link
Contributor

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!

@ahmetb
Copy link
Member

ahmetb commented Jan 21, 2020

Rather than the hosting of the image, the problem is to keep the API between container <=> service stable.

Since we don't use :latest in the image (and it would be dangerous to do so) any time we update the tag, we need to go update 20 other repos.

@rajatjindal
Copy link
Contributor Author

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

@ahmetb ahmetb merged commit cb2a459 into kubernetes-sigs:master Jan 25, 2020
@ahmetb
Copy link
Member

ahmetb commented Jan 25, 2020

Accidentally manually merged but
/lgtm
/approve

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants