94 doc release procedure#103
Conversation
|
|
Hi @SarahAlidoost , when you have time, can you help me review this PR? This PR is to fix a comment we got from the JOSS review, where the reviewer asked us to improve the Change Log, create templates to standardize the release process. While working on these suggestions, I think I can go one step further and created an agent skill to generate draft CHANGELOG info. This is the part I specifically want to ask for your input. You can run in GitHub Copilot |
SarahAlidoost
left a comment
SarahAlidoost
left a comment
There was a problem hiding this comment.
@rogerkuou looks good! 👍 Nice to see how SKILLS can be created for coding agents and how tasks can be done by agents. I haven't run the agent though, but I could run the script. I left some comments.
|
|
||
| --- | ||
|
|
||
| I will make a new release by preforming the following procedures: |
There was a problem hiding this comment.
| I will make a new release by preforming the following procedures: | |
| I will make a new release by preforming the following steps: |
| - The agent skill can be executed in GenAI prompt, e.g. GitHub Copilot Chat, by `/release-changelog vX.Y.Z` command, where `vX.Y.Z` is the new version label. | ||
| - Alternatively, one can run the helper script `bash .github/skills/release-changelog/scripts/generate_release_section.sh vX.Y.Z` to get bullets for the new release section. No newline at end of file |
There was a problem hiding this comment.
These are documentation on how the agent skill can be called. I suggest moving these two lines to the CONTRIBUTING.md under the section "Making a release".
| - [ ] Step3: Create release/tag at https://github.com/TUDelftGeodesy/sarxarray/releases | ||
|
|
||
| Hints: | ||
| - Step 1 and 2 can be done semi-automatically by calling agent skill in [release-changelog](.github/skills/release-changelog). However the changes will always be reviewed and commited by human. |
There was a problem hiding this comment.
Is there a documentation on how to call the agent if so, please add a link here.
| - [ ] Step1: Update version in pyproject.toml | ||
| - [ ] Step2: Update `docs/CHANGELOG.md` with new change information | ||
| - [ ] Step3: Create release/tag at https://github.com/TUDelftGeodesy/sarxarray/releases | ||
|
|
There was a problem hiding this comment.
In addition to this issue template, release guide should be added to the CONTRIBUTING.md under a section "Making a release", see example.
|
|
||
| ## When To Use | ||
|
|
||
| - You just created a new release tag and want changelog content. |
There was a problem hiding this comment.
Should the changelog be created/update before the release tag?
| - bash .github/skills/release-changelog/scripts/generate_release_section.sh vX.Y.Z vX.Y.(Z-1) | ||
|
|
||
| Notes: | ||
| - This supports changelog-first workflows where docs are built from release-triggered actions. |
There was a problem hiding this comment.
This sentence is not clear.
|
|
||
| See [releases](https://github.com/TUDelftGeodesy/sarxarray/releases) in the sarxarray repository for more details. | ||
|
|
||
| The information in this file can be generated automatically by LLM using the [release-changelog skill](.github/skills/release-changelog/SKILL.md). However, the generated content has always been reviewed and if necessary, edited by a human. |
There was a problem hiding this comment.
| The information in this file can be generated automatically by LLM using the [release-changelog skill](.github/skills/release-changelog/SKILL.md). However, the generated content has always been reviewed and if necessary, edited by a human. | |
| The information in this file can be generated automatically by LLM using the [release-changelog skill](../.github/skills/release-changelog/SKILL.md). However, the generated content has always been reviewed and if necessary, edited by a human. |
| - [ ] Step3: Create release/tag at https://github.com/TUDelftGeodesy/sarxarray/releases | ||
|
|
||
| Hints: | ||
| - Step 1 and 2 can be done semi-automatically by calling agent skill in [release-changelog](.github/skills/release-changelog). However the changes will always be reviewed and commited by human. |
There was a problem hiding this comment.
| - Step 1 and 2 can be done semi-automatically by calling agent skill in [release-changelog](.github/skills/release-changelog). However the changes will always be reviewed and commited by human. | |
| - Step 1 and 2 can be done semi-automatically by calling agent skill, see [release-changelog](.github/skills/release-changelog). However the changes will always be reviewed and commited by human. |
|
|
||
| In writing the software documentation and the JOSS paper, GPT-5 was used for language improvements for grammar correction and style edits. | ||
|
|
||
| Specifically, in the documentation process, an agent skill (under path `.github/skills/release-changelog`) is used to generate changelog entries from git tags and commit history. The generated content was always reviewed and edited by a human before being committed to the repository. |
There was a problem hiding this comment.
| Specifically, in the documentation process, an agent skill (under path `.github/skills/release-changelog`) is used to generate changelog entries from git tags and commit history. The generated content was always reviewed and edited by a human before being committed to the repository. | |
| Specifically, in the documentation process, an agent skill (under path `../.github/skills/release-changelog`) is used to generate changelog entries from git tags and commit history. The generated content was always reviewed and edited by a human before being committed to the repository. |
2 participants
fix #94