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

[Docs] Add initial CHANGELOG.md with changelogs from previous release #4708

Merged
merged 29 commits into from
Jun 21, 2024

Conversation

AdarshRawat1
Copy link
Member

@AdarshRawat1 AdarshRawat1 commented Jun 5, 2024

What does change log contain:

  • A summary of major changes
  • Details on new features
  • Bug fixes
  • Other notable improvements and modifications

Impact:

  • This changelog will be available on the documentation site.
  • Users and contributors can easily track changes and updates over time through the documentation site.

Screenshot

image

Reference

Based on this discussion - #4692 (comment)

Other changes

bumped up p4c_layout.xml v1.8.12 -->v1.11.0

@fruffy fruffy added the documentation Topics related to compiler documentation. label Jun 8, 2024
@fruffy
Copy link
Collaborator

fruffy commented Jun 8, 2024

Is this ready for review?

@AdarshRawat1
Copy link
Member Author

AdarshRawat1 commented Jun 8, 2024

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.

@AdarshRawat1 AdarshRawat1 marked this pull request as ready for review June 8, 2024 20:07
@@ -0,0 +1,3240 @@
<!-- \page changelog Changelog -->
Copy link
Collaborator

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.

Copy link
Collaborator

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.

Copy link
Member Author

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.

Copy link
Member Author

@AdarshRawat1 AdarshRawat1 Jun 12, 2024

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?

Copy link
Collaborator

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.

Copy link
Member Author

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.

@AdarshRawat1
Copy link
Member Author

AdarshRawat1 commented Jun 13, 2024

Screenshot of current changelog configuration [With awesome CSS] - view live here

image

@fruffy
Copy link
Collaborator

fruffy commented Jun 13, 2024

Screenshot of current changelog configuration [With awesome CSS] - view live here

image

Looks great!

@Dscano
Copy link

Dscano commented Jun 13, 2024

Looks good to me

@AdarshRawat1 AdarshRawat1 marked this pull request as draft June 15, 2024 07:04
@AdarshRawat1 AdarshRawat1 marked this pull request as ready for review June 15, 2024 09:10
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@fruffy fruffy left a 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.

@fruffy fruffy added this pull request to the merge queue Jun 21, 2024
Merged via the queue into p4lang:main with commit 60dfb1a Jun 21, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Topics related to compiler documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants