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

Add changelog #155

Merged
merged 8 commits into from
Nov 6, 2024
Merged

Add changelog #155

merged 8 commits into from
Nov 6, 2024

Conversation

dormrod
Copy link
Contributor

@dormrod dormrod commented Oct 10, 2024

Description

Add a clearer changelog for PLAMS. Whenever a PR is made, a summary of the change can be added to this log under the Unreleased header. Whenever a release is made, this will be converted to a 202Y.1xx header. This will also make it straightforward to create the "What's new in PLAMS" section of the doc at the end of the year.

I have started it by adding a list of the most significant/recent changes that will be in included in AMS 2025. I have also updated the "what's new" section of the docs to show how it might be constructed from the changelog.

Finally, the last standalone document build warnings due to missing files have been mitigated.

@dormrod dormrod requested a review from mhellstr October 10, 2024 11:08
Copy link
Contributor

@mhellstr mhellstr left a comment

Choose a reason for hiding this comment

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

Nice, but I think this Changelog should be part of the docs so that it is accessible to normal users who do not go to Github. A.k.a. the "what's new" section.

Things that only concern developers (generate_example.sh, Github workflows) should ideally be indicated as such.

@dormrod
Copy link
Contributor Author

dormrod commented Oct 11, 2024

Nice, but I think this Changelog should be part of the docs so that it is accessible to normal users who do not go to Github. A.k.a. the "what's new" section.

Things that only concern developers (generate_example.sh, Github workflows) should ideally be indicated as such.

Yes I was thinking about this, but also didn't want to "pollute" the "what's new" section with minor issues / implementation details.

So you think the changelog should be automatically pulled into the docs? Maybe it should be formatted in a way that it can be dropped straight in a .rst file then 🤔

@robertrueger
Copy link
Member

I also think it would be good to see the ChangeLog somewhere in the documentation. The ChangeLogs for AMS itself can also be found there, with lots of obscure little bugfixes:
https://www.scm.com/doc/Documentation/ChangeLog.html

The ChangeLog does not need to be the same as the "What's new" section. I'd image the latter only contains the large, user-facing new things, while the ChangeLog can contain all kinds of technical details and small fixes.

@dormrod dormrod force-pushed the DavidOrmrodMorley/changelog branch from 0d939a4 to 6d58622 Compare November 1, 2024 11:41
@dormrod dormrod force-pushed the DavidOrmrodMorley/changelog branch 4 times, most recently from 7b0e964 to 1c4523c Compare November 1, 2024 13:15
@dormrod dormrod force-pushed the DavidOrmrodMorley/changelog branch from 1c4523c to 6f4edb0 Compare November 1, 2024 13:16
@dormrod
Copy link
Contributor Author

dormrod commented Nov 1, 2024

I have also updated the "What's new" section for AMS2025, to show how this might be generated from the changelog

Copy link
Member

@robertrueger robertrueger left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@dormrod dormrod dismissed mhellstr’s stale review November 6, 2024 13:00

Discussed separately

@dormrod dormrod merged commit 61d521a into trunk Nov 6, 2024
14 checks passed
@dormrod dormrod deleted the DavidOrmrodMorley/changelog branch November 6, 2024 13:01
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.

3 participants