ESCOMP / ESCOMP/CTSM

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

Open
#2,766 1 comment 0 reactions 1 assignee Claimed by @ekluzek View on GitHub
b4b docs-loc:codebase docs:update documentation enhancement test: none usability
Dominant language
Fortran
Stars
352
Forks
361
Avg merge
2d 21h
Merged PRs (30d)
7

Description

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:

- [x] Change the RTM ChangeLog to markdown: https://github.com/ESCOMP/RTM/blob/master/docs/ChangeLog.md
- [x] Change the MOSART/RTM ChangeLog to markdown
- [ ] 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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.