-
Notifications
You must be signed in to change notification settings - Fork 434
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
[Docs] Add initial CHANGELOG.md with changelogs from previous release #4708
Conversation
- Logged all the changes for previous Releases. - Added "View" hypertext instead of commit numbers
Is this ready for review? |
Yes, we can merge this, as this is just the initial configuration for changelogs. I'm formatting the previous changelogs as per the current release format.[i.e. Under categories - Breaking changes , p4 specific implementation etc]. It can be done separately. |
docs/CHANGELOG.md
Outdated
@@ -0,0 +1,3240 @@ | |||
<!-- \page changelog Changelog --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would remove all the commits before the earliest known release. They are just noise. We can add a note that only the commit history is available for those.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also shouldn't this be in the top-level?
We can also add some boilerplate to explain our semantic versioning. The release cadence is monthly and the Major/Minor/Patch versions are tied to the P4 specification. The revision (the last number) is incremented each month.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added notes for semantics and previous commits, though they do need some polishing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would remove all the commits before the earliest known release. They are just noise. We can add a note that only the commit history is available for those.
Should we also remove the current latest release when the next release comes out next month, or should we append the newer release to the list?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was looking at https://github.com/AdarshRawat1/p4c/blob/Docs-Changelogs/CHANGELOG.md
The version that included previous releases was fine, but that list only went until v1.2.2. We can keep the changelog until that point, then delegate to the git commit history before that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh Thanks !! , I understand it now.
…into Docs-Changelogs
Screenshot of current changelog configuration [With awesome CSS] - view live here |
Looks great! |
Looks good to me |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's get this in, we can always improve minor problems later.
What does change log contain:
Impact:
Screenshot
Reference
Based on this discussion - #4692 (comment)
Other changes
bumped up
p4c_layout.xml
v1.8.12 -->v1.11.0