Skip to content

Client specification: point changelog to tags, add maintainer note #5482

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

Merged
merged 3 commits into from
Mar 25, 2021

Conversation

mebeim
Copy link
Member

@mebeim mebeim commented Mar 19, 2021

This converts the links in the changelog of the client spec to point to version tags instead of commit hashes as suggested by @bl-ue in #5428, and also includes a maintainer note in the form of a comment for future reference when updating the changelog.

I've already pushed the tags from v1.0 to v1.5, which should be visible to everyone here.

Also include a maintainer note in the form of a comment for
future reference when updating the changelog.
@mebeim mebeim added documentation Issues/PRs modifying the documentation. clients Issues pertaining to a particular client or the clients as whole. labels Mar 19, 2021
@bl-ue
Copy link
Contributor

bl-ue commented Mar 19, 2021

Also see my comment here: #5428 (comment)

@mebeim
Copy link
Member Author

mebeim commented Mar 19, 2021

Quoting your comment from #5428 just to keep the discussion here:

Hmm...I didn't get notified about this. @mebeim I think we need to create an actual release, not just a tag thinking

I actually get GH notifications when I'm watching a repository and they create a release. For example, I was notified when https://github.com/kubernetes/kubernetes/releases/tag/v1.20.5 was released.

Makes sense. I should add this to the maintainer note in the comment then. Should we go ahead and just create a v1.5 release? Previous versions don't strictly need an actual release, but we could do that too.

@bl-ue
Copy link
Contributor

bl-ue commented Mar 19, 2021

Yes, I think we should. 👍🏻 No one needs to be notified about previous spec versions because the changes made in v1.0-1.4 are incorporated into v1.5.

@mebeim
Copy link
Member Author

mebeim commented Mar 20, 2021

Done and done 👍

@sbrl
Copy link
Member

sbrl commented Mar 25, 2021

Is there anything else specific that needs doing after we merge this?

@sbrl sbrl merged commit 4824f90 into master Mar 25, 2021
@sbrl sbrl deleted the mebeim/client-spec-tags branch March 25, 2021 00:38
@bl-ue
Copy link
Contributor

bl-ue commented Mar 25, 2021

I don't think so, @sbrl. 👍🏻

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clients Issues pertaining to a particular client or the clients as whole. documentation Issues/PRs modifying the documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants