Skip to content

Improve formatting of release notes#1396

Merged
thehomebrewnerd merged 7 commits intomainfrom
format-relase-notes
Apr 8, 2021
Merged

Improve formatting of release notes#1396
thehomebrewnerd merged 7 commits intomainfrom
format-relase-notes

Conversation

@thehomebrewnerd
Copy link
Contributor

Improve formatting of release notes

  • Adds sections for each release to create a link for each release on the right hand side of the release notes page for easier navigation
  • Creates subsection for Breaking Changes to highlight better
  • Use consistent 3-letter abbreviation for month of release

@thehomebrewnerd thehomebrewnerd requested a review from rwedge April 8, 2021 17:25
@codecov
Copy link

codecov bot commented Apr 8, 2021

Codecov Report

Merging #1396 (e0b6941) into main (dd6c6f7) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1396   +/-   ##
=======================================
  Coverage   98.58%   98.58%           
=======================================
  Files         135      135           
  Lines       14578    14578           
=======================================
  Hits        14372    14372           
  Misses        206      206           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dd6c6f7...e0b6941. Read the comment docs.

@rwedge
Copy link
Contributor

rwedge commented Apr 8, 2021

Let's update release.md instructions to use the new format as well

@thehomebrewnerd
Copy link
Contributor Author

Let's update release.md instructions to use the new format as well

Updated!

release.md Outdated
```
.. **Future Release**
.. Future Release
==============
Copy link
Contributor

Choose a reason for hiding this comment

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

got a warning when I added this template to the release notes, adding a 2 space indent to this line fixed it

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, ok. Wasn't real sure how to handle this one cleanly. Added spaces.

Copy link
Contributor

@rwedge rwedge left a comment

Choose a reason for hiding this comment

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

:shipit:

@thehomebrewnerd thehomebrewnerd merged commit 1fa376d into main Apr 8, 2021
@thehomebrewnerd thehomebrewnerd deleted the format-relase-notes branch April 8, 2021 20:33
@rwedge rwedge mentioned this pull request Apr 30, 2021
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