chore: add CHANGELOG.md, PR changelog check, and release workflow#581
Open
joaodordio wants to merge 1 commit into
Open
chore: add CHANGELOG.md, PR changelog check, and release workflow#581joaodordio wants to merge 1 commit into
joaodordio wants to merge 1 commit into
Conversation
Introduce a CHANGELOG.md reconstructed from the project's tagged GitHub Releases, add the shared changelog-check workflow that fails a PR when CHANGELOG.md is not updated unless the description states "No customer facing changes", and add a Prepare Release workflow that stamps the Unreleased section into a versioned entry (keeping the Unreleased header) and bumps package.json, mirroring the other SDKs. Also documents the opt-out in the PR template.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #581 +/- ##
=======================================
Coverage 74.43% 74.43%
=======================================
Files 57 57
Lines 2742 2742
Branches 804 821 +17
=======================================
Hits 2041 2041
+ Misses 700 660 -40
- Partials 1 41 +40 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📝 Summary
Add a
CHANGELOG.md(backfilled from tagged releases), the shared PR changelog check, and a Prepare Release workflow that stamps the Unreleased section.🎟️ Jira Ticket: N/A — internal SDK tooling
📖 Description
Brings the Web SDK in line with the other Iterable SDKs on changelog handling:
CHANGELOG.md, reconstructed from the project's tagged GitHub Releases (stable versions only;-test/-betapre-releases excluded), in the Keep a Changelog format used by the other SDKs..github/workflows/changelog-check.yml, which fails a PR whenCHANGELOG.mdis not updated unless the description contains "No customer facing changes". Identical to the workflow on the other SDK repos..github/workflows/prepare-release.yml, aworkflow_dispatchrelease-prep workflow mirroring android/swift: it moves the## [Unreleased]section under the new version header (keeping an empty## [Unreleased]), bumps thepackage.jsonversion, and opens a release PR.🧪 How to test?
CHANGELOG.md, so the newVerify CHANGELOG updatecheck passes on file change.Prepare Releaseworkflow via workflow_dispatch with a version (e.g.2.3.0) and confirm the resulting PR stamps the Unreleased content under## [2.3.0], keeps an empty## [Unreleased], and bumpspackage.json.🧾 Changelog
No customer facing changes (SDK tooling only).
📹 Loom recording if applicable
N/A
🐞 Github Issues solved
N/A
📚 Docs PR if applicable
N/A