Skip to content

Add CHANGELOG and Update Documents#832

Merged
g-saracca merged 8 commits intodevelopfrom
828-add-changelog-and-update-documents
Sep 23, 2025
Merged

Add CHANGELOG and Update Documents#832
g-saracca merged 8 commits intodevelopfrom
828-add-changelog-and-update-documents

Conversation

@ChengShi-1
Copy link
Contributor

What this PR does / why we need it:

Based on Changelog Strategy doc, and #804 , we discussed on the frontend meeting Sep11th 2025, we decide to move forward and create an issue to add CHANGELOG to the front repo.

Which issue(s) this PR closes:

Special notes for your reviewer:

Suggestions on how to test this:

Documents change only, it'll be good if you could review the markdown format and wording

Is there a release notes update needed for this change?:

Add Changelog.md to the repo and update related markdown files, such as README, Contributing...

@ChengShi-1 ChengShi-1 linked an issue Sep 16, 2025 that may be closed by this pull request
@github-actions github-actions bot added FY26 Sprint 6 FY26 Sprint 6 (2025-09-10 - 2025-09-24) GREI Re-arch GREI re-architecture-related SPA.Q3.2025 labels Sep 16, 2025
@ChengShi-1 ChengShi-1 added Size: 0.5 A percentage of a sprint. 0.35 hours Original size: 0.5 labels Sep 16, 2025
@ChengShi-1 ChengShi-1 moved this to Ready for Review ⏩ in IQSS Dataverse Project Sep 16, 2025
@ChengShi-1 ChengShi-1 marked this pull request as ready for review September 16, 2025 20:00
@ChengShi-1 ChengShi-1 added the documentation Changes only affect the documentation label Sep 16, 2025
@ekraffmiller ekraffmiller self-assigned this Sep 16, 2025
@ekraffmiller ekraffmiller moved this from Ready for Review ⏩ to In Review 🔎 in IQSS Dataverse Project Sep 16, 2025
Copy link
Contributor

@ekraffmiller ekraffmiller left a comment

Choose a reason for hiding this comment

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

A general question, I think in our meeting we decided that each PR would have a corresponding update to the Changelog? If so, we could make the documentation more clear about that.

@coveralls
Copy link

coveralls commented Sep 16, 2025

Coverage Status

coverage: 97.448% (-0.6%) from 98.052%
when pulling 774e465 on 828-add-changelog-and-update-documents
into ca0c27f on develop.

@ChengShi-1
Copy link
Contributor Author

ChengShi-1 commented Sep 16, 2025

@ekraffmiller sorry, I didn't update it to my draft so forgot this. I add a folder named releases-note to collect the changelog fragments, which is similar to what we did in dataverse repo. Thanks for reviewing


We maintain separate changelogs for different components:

- **Main application changes**: Create fragments in [`docs/release-notes/`](../docs/release-notes/)
Copy link
Contributor

Choose a reason for hiding this comment

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

In our meeting I think we discussed updating the CHANGELOG.md directly, rather than creating individual fragments for each PR. We discussed how there would be merge conflicts but they would be relatively straightforward to resolve. Unless I am misremembering?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ohh, I see—I misunderstood. I thought the part about merge conflicts was explaining why we don’t need an automation tool, and I also thought you were referring to me missing the fragment part last comment. Sorry about that! But it makes sense now, and I can change it back.

Copy link
Contributor

@ekraffmiller ekraffmiller 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, approved!

@github-project-automation github-project-automation bot moved this from In Review 🔎 to Ready for QA ⏩ in IQSS Dataverse Project Sep 17, 2025
@g-saracca g-saracca merged commit 0a0a2dc into develop Sep 23, 2025
10 of 12 checks passed
@github-project-automation github-project-automation bot moved this from Ready for QA ⏩ to Merged 🚀 in IQSS Dataverse Project Sep 23, 2025
@pdurbin pdurbin moved this from Merged 🚀 to Done 🧹 in IQSS Dataverse Project Sep 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Changes only affect the documentation FY26 Sprint 6 FY26 Sprint 6 (2025-09-10 - 2025-09-24) GREI Re-arch GREI re-architecture-related Original size: 0.5 Size: 0.5 A percentage of a sprint. 0.35 hours SPA.Q3.2025

Projects

Status: Done 🧹

Development

Successfully merging this pull request may close these issues.

Add CHANGELOG and Update Documents

4 participants