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

Improve accuracy and detail of release notes #3103

Closed
2 tasks done
austin-hall-skylight opened this issue Jan 6, 2025 · 0 comments · Fixed by #3187
Closed
2 tasks done

Improve accuracy and detail of release notes #3103

austin-hall-skylight opened this issue Jan 6, 2025 · 0 comments · Fixed by #3187
Assignees
Labels
Streamline eCR Issues for Streamline eCR team to work on

Comments

@austin-hall-skylight
Copy link
Collaborator

austin-hall-skylight commented Jan 6, 2025

What needs to be done

  • Update repo settings to use pull request title and description as squashed and merged commit message
  • Update release workflow to use commit messages since last release instead of closed pull request titles

Why it needs to be done

Release notes currently include PR's that have been closed but not merged. This will fix that error as well as giving us more detailed information about each PR that is included in the release.

Acceptance Criteria

  • Release notes contain the title and description for each merged pull request included in the release
  • Pull requests that have been closed but not merged are not included in the release notes

Technical Notes

  • PR commit message settings can be found in Settings > General > Pull Requests > Default commit message (new value should be Pull request title and description)
  • Workflow changes will take place in .github/workflows/createNewRelease.yaml, step "Generate release notes"

Additional context

n/a

@austin-hall-skylight austin-hall-skylight added the Streamline eCR Issues for Streamline eCR team to work on label Jan 6, 2025
@BobanL BobanL self-assigned this Jan 21, 2025
github-merge-queue bot pushed a commit that referenced this issue Jan 23, 2025
# PULL REQUEST

## Summary

- Update release action to auto generate release notes
- [Tag will get created if it does not
exist](https://cli.github.com/manual/gh_release_create#:~:text=If%20a%20matching%20git%20tag%20does%20not%20yet%20exist%2C%20one%20will%20automatically%20get%20created%20from%20the%20latest%20state%20of%20the%20default%20branch.)
- [Title will automatically be created based on the
tag](https://cli.github.com/manual/gh_release_create#:~:text=When%20using%20automatically%20generated%20release%20notes%2C%20a%20release%20title%20will%20also%20be%20automatically%20generated%20unless%20a%20title%20was%20explicitly%20passed.%20Additional%20release%20notes%20can%20be%20prepended%20to%20automatically%20generated%20notes%20by%20using%20the%20%2D%2Dnotes%20flag.)
 
## Related Issue

Fixes #3103

## Acceptance Criteria

- [x] Release notes contain the title and description for each merged
pull request included in the release
- [x] Pull requests that have been closed but not merged are not
included in the release notes

## Additional Information

Example of what `gh release create 0.0.2 --generate-notes` will create: 

![image](https://github.com/user-attachments/assets/d41ce1d8-bf95-4dab-a096-b8785969447c)

## Checklist

- [ ] If this code affects the other scrum team, have they been
notified? (In Slack, as reviewers, etc.)

[//]: # "PR title: Remember to name your PR descriptively!"
robertmitchellv pushed a commit that referenced this issue Jan 23, 2025
# PULL REQUEST

## Summary

- Update release action to auto generate release notes
- [Tag will get created if it does not
exist](https://cli.github.com/manual/gh_release_create#:~:text=If%20a%20matching%20git%20tag%20does%20not%20yet%20exist%2C%20one%20will%20automatically%20get%20created%20from%20the%20latest%20state%20of%20the%20default%20branch.)
- [Title will automatically be created based on the
tag](https://cli.github.com/manual/gh_release_create#:~:text=When%20using%20automatically%20generated%20release%20notes%2C%20a%20release%20title%20will%20also%20be%20automatically%20generated%20unless%20a%20title%20was%20explicitly%20passed.%20Additional%20release%20notes%20can%20be%20prepended%20to%20automatically%20generated%20notes%20by%20using%20the%20%2D%2Dnotes%20flag.)
 
## Related Issue

Fixes #3103

## Acceptance Criteria

- [x] Release notes contain the title and description for each merged
pull request included in the release
- [x] Pull requests that have been closed but not merged are not
included in the release notes

## Additional Information

Example of what `gh release create 0.0.2 --generate-notes` will create: 

![image](https://github.com/user-attachments/assets/d41ce1d8-bf95-4dab-a096-b8785969447c)

## Checklist

- [ ] If this code affects the other scrum team, have they been
notified? (In Slack, as reviewers, etc.)

[//]: # "PR title: Remember to name your PR descriptively!"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Streamline eCR Issues for Streamline eCR team to work on
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants