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 a release template to the compiler. #4692

Merged
merged 2 commits into from
May 30, 2024
Merged

Add a release template to the compiler. #4692

merged 2 commits into from
May 30, 2024

Conversation

fruffy
Copy link
Collaborator

@fruffy fruffy commented May 30, 2024

This follows the guide listed here: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes

I am not sure whether this will work. Fixes #4690.

@AdarshRawat1 We are also trying to improve our release logs. Do you have any ideas or suggestions how to have better information or templates here? We usually release on a monthly cadence.

@rst0git Do you know whether this will work with the automated release we use?

@fruffy fruffy added the infrastructure Topics related to code style and build and test infrastructure. label May 30, 2024
@fruffy fruffy requested review from asl and vlstill May 30, 2024 12:28
Copy link
Contributor

@asl asl left a comment

Choose a reason for hiding this comment

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

This looks as a great path forward!

@AdarshRawat1
Copy link
Member

AdarshRawat1 commented May 30, 2024

This follows the guide listed here: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes

Kudos 🙌, Looks great.

@AdarshRawat1 We are also trying to improve our release logs. Do you have any ideas or suggestions how to have better information or templates here? We usually release on a monthly cadence.

I do have a few suggestions.

  • A Changelog.doc, will help us link the change logs to documentation as well. Sample Output
  1. We can copy the format [output] that you are creating in this PR and add them to CHANGELOG file
  2. or We can use https://github.com/requarks/changelog-action to get change logs based on commits [This will use commit Message prefix to categorize the change, we will have to follow new standards for commits]

  • [Extra] Keeping an Unreleased tag version containing current commits where users can track upcoming changes in next release

@fruffy
Copy link
Collaborator Author

fruffy commented May 30, 2024

or We can use https://github.com/requarks/changelog-action to get change logs based on commits [This will use commit Message prefix to categorize the change, we will have to follow new standards for commits]

I think an automated changelog every month is a good idea. We can have this running similar to what we do for releases. It's good to keep a log separately from the Github.com log.

@fruffy fruffy added this pull request to the merge queue May 30, 2024
Merged via the queue into main with commit b0d4d02 May 30, 2024
17 checks passed
@fruffy fruffy deleted the fruffy/release_yaml branch May 30, 2024 18:40
@rst0git
Copy link
Member

rst0git commented Jun 1, 2024

Do you know whether this will work with the automated release we use?

@fruffy This is a good idea. There will be an automated release later today and we can see if it works.

@fruffy
Copy link
Collaborator Author

fruffy commented Jun 1, 2024

https://github.com/p4lang/p4c/releases/tag/v1.2.4.12

Seems to work well!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure Topics related to code style and build and test infrastructure.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Informing downstream compilers about sigificant code changes and how to migrate?
4 participants