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.
| - 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".
There was a problem hiding this comment.
Moved this to COONTRIBUTING.md
| - [ ] 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.
There was a problem hiding this comment.
Pointing to CONTRIBUTING.md now
| - [ ] 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.
There was a problem hiding this comment.
Added this section to CONTRIBUTING.md
|
|
||
| ## 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?
There was a problem hiding this comment.
Indeed! I updated to You are preparing a new release and want to generate a new section in the changelog.
| - 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.
There was a problem hiding this comment.
I removed this sentence. This was coming from a try, when I wanted enforce the agent to understand that the changlog information needs to be updated before a release is made. Now I found it's not necessary.
To follow up, I could run the agent successfully. I ran git diff docs/CHANGELOG.md+## Unreleased
+
+## [v1.2.4] - 2026-07-01
+
+Compared to: v1.2.3..HEAD (pre-tag draft)
+
+### Added
+- Add an issue template
+- Add agent skills for generating CHANGELOG
+- Add read_metadata to_binary and crop to API docs
+- Add output file test for to_binary
+- Fix linting, add tests
+- Add Simon as an author
+- Add a data downloading cell in the example notebook
+- Add more sections
+- Add complex coherence computation
+- Add SURF grant numbers
+- Add GitHub Action for paper
+- Add draft paper
+
+### Changed
+- Update issue template
+- Update AI usage disclosure section in JOSS paper
+- Update CHANGELOG
+- Update citation file
+- Remove list ensurance since this is already done in read_metadat
a
+- Update installation guide in docs
+- Update README with extra dependencies and zsh safe format
+- Update paper
+- Update software name in README to SARXarray
+- Update workflow
+
+### Fixed
+- Fix DOI links in JOSS paper
+- Fix typo
+
+### Docs
+- Update docs/api_reference.md
+- Add missing tickmark in docstring
+- Fix docstring
+
+### CI
+- Split filewriting test in dataset and dataarray
+- Test more edge cases in io
+- Remove da_crop reference in ValueError test
+- Add ValueError test
+- Add crop test, allow for non-integer crops
+ |
Co-authored-by: SarahAlidoost <55081872+SarahAlidoost@users.noreply.github.com>
|
|
Thanks @SarahAlidoost . I have adapted all your comments. Merging now. |
2 participants
fix #94