Skip to content

Conversation

@yousefmoazzam
Copy link
Collaborator

Fixes IMGDA-539

Most of the content is likely uninteresting, the main things that we as developers need to know, and the things that users will see (and thus should be considered by us to ensure it's intuitive for users) are the following:

  • developers
    • the asset is a file called user-release-notes.txt and can be given any name, it was chosen arbitrarily to have something to work with, feedback/discussion is welcome
    • the label user-release-note can be given any name, it was chosen arbitrarily to have something to work with, feedback/discussion is welcome
    • whatever label name is chosen, it should be applied to any PR that is desired to be put into the "user release notes" section in the release notes
    • the label can be applied to the PR even after it's been merged; all that matters is that the PR has the label at the time of the github action being triggered (meaning, it's possible to retrospectively add the label as needed before making a release)
  • users
    • the title "Notable Changes for Users" can be anything, it was chosen arbitrarily to have something to work with, feedback/discussion is welcome
    • each line in the autogenerated release notes have the PR title, the github user handle of the PR author, and the PR number; the PR author and PR number have been stripped out in the asset (for example, * Add some more useful info to users by @yousefmoazzam in #43 becomes * Add some more useful info to users)

Below is a screenshot of what the release notes look like (ignore the superficial details like a different asset filename, the main intent is to give an idea of the overall visual structure):
github-release-notes-and-asset

Lastly, any other feedback/discussion around what could be changed/improved/removed etc. is welcome! 🙂

Checklist

  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have made corresponding changes to the documentation

@dkazanc
Copy link
Collaborator

dkazanc commented Feb 12, 2026

thanks @yousefmoazzam . I think it looks good and I'm OK with the chosen labels/files. One little thing, shall we update our PR template checklist with some of that information ? I'd add another checkbox like:

  • I have added information into Notable Changes for Users and enable them by adding the label user-release-note

or something along those lines?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants