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

Change format of ChangeLog/ChangeSum file to markdown starting with ctsm6.0.0 #2766

Open
7 tasks
ekluzek opened this issue Sep 17, 2024 · 1 comment
Open
7 tasks
Labels
bfb bit-for-bit documentation additions or edits to user-facing documentation enhancement new capability or improved behavior of existing capability test: none No tests required (e.g. tools/contrib) usability Improve or clarify user-facing options

Comments

@ekluzek
Copy link
Collaborator

ekluzek commented Sep 17, 2024

This goes along with #2761 for the ChangeLog/ChangeSum files specifically. Moving them to markdown format would render them better in both github and VS code. This would also automate references to issues and PR's on github as well.

We talked about this some in the CTSM SE after I had learned about using github actions to help manage ChangeLog

https://docs.google.com/document/d/1tgDRocjAFF1svWjt0mvjjPaPLFuDZEHLpf4vlGIQs5o/edit#heading=h.b0h9msqpz720

The SEA ISS conference had a talk about using a github action towncrier to help manage the ChangeLog. See the talk here:

https://www.youtube.com/watch?v=uFQ8xSzlkwY?t=1:21:19

I think the first step would just be to move to Markdown, and later steps would be to use something like towncrier (which I especially think would be helpful for the b4b-dev branch).

End goal: you add relevant information to the PR template in GH, and then when you push to master gh actions updates the Changelog and Changesum - so no person ever actually edits either document.

Definition of done:

  • Change ChangeSum to markdown format and rename to ChangeSum.md
  • Update the script so that the ChangeSum.md is handled correctly
  • Change an empty ChangeLog to markdown format rename to ChangeLog.md
  • Update the script to correctly handle the ChangeLog.md file
  • Look into github tools and actions such as towncrier to help automate the process
  • Decide on what tools to use and what the process should look like
  • Start implementing the new automated process
@ekluzek ekluzek added enhancement new capability or improved behavior of existing capability documentation additions or edits to user-facing documentation test: none No tests required (e.g. tools/contrib) next this should get some attention in the next week or two. Normally each Thursday SE meeting. bfb bit-for-bit usability Improve or clarify user-facing options labels Sep 17, 2024
@ekluzek ekluzek added this to the ctsm6.0.0 (code freeze) milestone Sep 17, 2024
@wwieder wwieder removed the next this should get some attention in the next week or two. Normally each Thursday SE meeting. label Sep 19, 2024
@wwieder
Copy link
Contributor

wwieder commented Sep 19, 2024

@samsrabin noted ChangeSum could be a markdown table.
Broad support for getting this in place by the CLM6.0 release!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bfb bit-for-bit documentation additions or edits to user-facing documentation enhancement new capability or improved behavior of existing capability test: none No tests required (e.g. tools/contrib) usability Improve or clarify user-facing options
Projects
Development

No branches or pull requests

2 participants