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

Publish release notes automatically with github actions #878

Closed
feiskyer opened this issue Oct 26, 2021 · 13 comments · Fixed by #1014
Closed

Publish release notes automatically with github actions #878

feiskyer opened this issue Oct 26, 2021 · 13 comments · Fixed by #1014
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt.

Comments

@feiskyer
Copy link
Member

When cutting new releases, the following commands could be used to generate the release notes:

GO111MODULE=on go install k8s.io/release/cmd/release-notes@latest

release-notes --repo=cloud-provider-azure \
	--org=kubernetes-sigs \
	--branch=release-1.1 \
	--start-sha=$(git rev-parse v1.1.1) \
	--end-sha=$(git rev-parse v1.1.2) \
	--output=v1.1.2.md

The same commands could be executed in github actions and hence the release notes could be published automatically.

@feiskyer feiskyer added the kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. label Oct 26, 2021
@nilo19 nilo19 added the good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. label Dec 23, 2021
@Darshnadas
Copy link

Can I take this issue?

@Darshnadas
Copy link

/assign

@Darshnadas
Copy link

Can someone tell me that these commands, shall be written in a new script?

@feiskyer
Copy link
Member Author

Thanks for taking this. Yes, release-notes could be installed and invoked in a new script

@Darshnadas
Copy link

Hi @feiskyer sorry for replying late, but can you help me understand this issue more briefly? This is my first time working on this type of issue, it will be really helpful if you can explain by release-notes installed and what has to be done? Can you explain me more clearly?

@feiskyer
Copy link
Member Author

feiskyer commented Jan 6, 2022

Generally, it could be done in 4 steps:

  1. collect the branch name and github tags
  2. Install by GO111MODULE=on go install k8s.io/release/cmd/release-notes@latest
  3. run release-notes ... as shared above
  4. publish the contents of result in github releases as well as the releases

@Darshnadas
Copy link

For all the releases? does it have to publish separately or at once for all the releases it can published?

@zarvd
Copy link
Contributor

zarvd commented Jan 7, 2022

When we push a new release tag, it should trigger the action to generate release-note and publish release. Right?

https://github.com/softprops/action-gh-release may help (example: https://github.com/linkerd/linkerd2/blob/main/.github/workflows/release.yml).

@Darshnadas
Copy link

Hi, @luncj I will read them and again get back to you or @feiskyer. It'll be easier if I start a slack thread regarding this issue, will it be okay?

@zarvd
Copy link
Contributor

zarvd commented Jan 18, 2022

Hi, @Darshnadas. Is there any progress? I will help solve this issue along with #879.

@Darshnadas
Copy link

Hi @luncj, unfortunately, I have been busy with another work, will start with this issue this week.

@feiskyer
Copy link
Member Author

@Darshnadas thanks for the reply. this is already done by #1014.

@Darshnadas
Copy link

Okay, @feiskyer. Will look forward to contribute to another issue :)

@Darshnadas Darshnadas removed their assignment Jan 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants