You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 98beeb5
Browse filesBrowse the repository at this point in the historyBrowse files
* Add changelog fragments
Signed-off-by: Christoph Knittel <ck@cca.io>
* Fix changelog fragment review findings
Move the check to its own workflow, exempt Dependabot, insert notes newest
PR first without splitting lists, and refuse to publish with leftover fragments.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Christoph Knittel <ck@cca.io>
* Run release plan tests in CI
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Christoph Knittel <ck@cca.io>
* Guard CHANGELOG.md edits and add changelog:open
Reject CHANGELOG.md edits without changelog:release, explain the placeholder
link and draft PR flow, and open the next unreleased section by command.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Christoph Knittel <ck@cca.io>
* Turn the PR template into a short checklist
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Christoph Knittel <ck@cca.io>
* Drop the unused Spec Compliance category
It was used once, in 10.1.0-rc.1.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Christoph Knittel <ck@cca.io>
* Move changelog fragments to changes/
Yarn always packs a root changelog directory, which would ship fragments
in the npm package and break the artifact list check.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Christoph Knittel <ck@cca.io>
* Collect late fragments into a finalized version
Publish blocks on fragments merged after release preparation; rerunning
changelog:release now adds them instead of failing on the finalized heading.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XJG88tCTovUPzEf2nxUPtq
Signed-off-by: Christoph Knittel <ck@cca.io>
* Keep late fragments out of tagged versions
Publish tags vX before publishing, so a tagged version is treated as
published and its notes are no longer extended.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XJG88tCTovUPzEf2nxUPtq
Signed-off-by: Christoph Knittel <ck@cca.io>
* Document not collecting notes during a Publish run
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XJG88tCTovUPzEf2nxUPtq
Signed-off-by: Christoph Knittel <ck@cca.io>
---------
Signed-off-by: Christoph Knittel <ck@cca.io>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: AGENTS.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -97,7 +97,7 @@ on `master`. CI runs on every PR in the stack.
97
97
98
98
## Testing and changelog
99
99
100
-
**Add a `CHANGELOG.md`entry**for any user-facing change (bug fix, feature, or breaking change). Put it under the matching section of the current `(Unreleased)` version and end the line with the PR link. See [CONTRIBUTING.md](CONTRIBUTING.md). PRs are expected to include one.
100
+
**Add a changelog fragment**`changes/<description>.<category>.md` for any user-facing change (bug fix, feature, or breaking change) instead of editing `CHANGELOG.md`; see [changes/README.md](changes/README.md) for categories and format. Validate with `yarn changelog:check`. Since the PR number is not known yet, open the PR as a draft with the placeholder link`https://github.com/rescript-lang/rescript/pull/XXXX`, then replace it with the real link, amend, push again, and mark the PR ready for review (`gh pr ready`).
101
101
102
102
For compiler or standard-library changes, run `make test`. For syntax changes,
103
103
also run `make test-syntax`; use `make test-syntax-roundtrip` when parsing or
Copy file name to clipboardExpand all lines: CHANGELOG.md
-3Lines changed: 0 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,6 @@
3
3
> **Tags:**
4
4
>
5
5
> -:boom:[Breaking Change]
6
-
> -:eyeglasses:[Spec Compliance]
7
6
> -:rocket:[New Feature]
8
7
> -:bug:[Bug Fix]
9
8
> -:memo:[Documentation]
@@ -19,8 +18,6 @@
19
18
- Remove the call-site `@inlined` attribute, which was parsed but never affected code generation. It is now reported as a misplaced attribute (warning 53). https://github.com/rescript-lang/rescript/pull/8734
20
19
- Remove `@deriving(abstract)` and `@deriving(jsConverter)`. Use record types (with optional fields, mutable fields and `@as` renaming) and polymorphic variants directly instead. https://github.com/rescript-lang/rescript/pull/8729
21
20
22
-
#### :eyeglasses: Spec Compliance
23
-
24
21
#### :rocket: New Feature
25
22
26
23
- Support Windows 11 on ARM by installing the x64 binaries, which Windows runs through its x64 emulation. https://github.com/rescript-lang/rescript/pull/8776
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -510,7 +510,7 @@ Adding a new entry there requires re-running the analysis tests. Follow these st
510
510
511
511
(If a `make`command fails, consider using the [DevContainer](#b-devcontainer).)
512
512
513
-
Finally, add a line to [CHANGELOG.md](CHANGELOG.md), using the `#### :nail_care: Polish` section.
513
+
Finally, add a `changes/<description>.polish.md` fragment following [the changelog instructions](changes/README.md).
514
514
515
515
## Code structure
516
516
@@ -572,7 +572,7 @@ The repository's `npm-release` GitHub environment should have required reviewers
572
572
To build a new version and release it on NPM, follow these steps:
573
573
574
574
1. Verify that the version number is already set correctly for the release. (It should have been incremented after releasing the previous version.)
575
-
1. Create a PR to update `CHANGELOG.md`, removing the "(Unreleased)"forthe version to be released.
575
+
1. Run `yarn changelog:preview` to review pending notes, then`yarn changelog:release` to collect fragments into `CHANGELOG.md`, remove "(Unreleased)", and delete consumed fragments. Create a PR containing these changes, review the combined release notes, and apply the `changelog:release` label. Existing unreleased entries are preserved. If more fragments are merged before publishing, the `Publish` workflow refuses to run; repeat this step to add them to the same version. Don't run `yarn changelog:release` while a `Publish` run is in progress: it could add notes for changes that the run is not publishing.
576
576
1. Once that PR is merged and built successfully, run the `Publish` workflow from the GitHub Actions tab. Use the "Run workflow" branch dropdown to select the release branch (normally `master`, or the relevant maintenance branch) and indicate whether this is the current stable release. The version is read from that branch's `package.json`, and the npm tag is derived automatically:
577
577
- A current stable release is published as `latest`.
578
578
- A stable maintenance release for an older major is published as `latest-<major>`, for example `latest-12`.
@@ -585,7 +585,7 @@ To build a new version and release it on NPM, follow these steps:
585
585
1. Create a PR with the following changes to prepare for development of the next version:
586
586
- Increment the `EXPECTED_VERSION` number in`yarn.config.cjs`for the next version.
587
587
- Run `yarn constraints --fix` to take that version number over into other files.
588
-
- Update `CHANGELOG.md` and add an entry for the next version, e.g., "10.0.0-beta.2 (Unreleased)"
588
+
- Run `yarn changelog:open` to add the empty "(Unreleased)" section for the next version to `CHANGELOG.md`, and apply the `changelog:release` label to the PR.
Add a unique `<description>.<category>.md` file for each change that needs release notes. For example, `fix-watcher-recovery.fix.md`:
4
+
5
+
```markdown
6
+
- Recover blocked dependents after a failed build. https://github.com/rescript-lang/rescript/pull/8667
7
+
```
8
+
9
+
The PR number is only known once the PR exists, so open it as a draft with the placeholder link `https://github.com/rescript-lang/rescript/pull/XXXX`, replace the placeholder with the real link, amend and push again, then mark the PR ready for review. The changelog check fails while the placeholder remains. Each file may contain multiple bullets in the same category. Indent wrapped lines by two spaces; each bullet ends with one or more PR links.
10
+
11
+
| Category | Section |
12
+
| --- | --- |
13
+
|`breaking`| Breaking Change |
14
+
|`feature`| New Feature |
15
+
|`fix`| Bug fix |
16
+
|`docs`| Documentation |
17
+
|`polish`| Polish |
18
+
|`internal`| Internal |
19
+
20
+
`yarn changelog:check` validates all fragments. CI requires a newly added fragment relative to the PR merge base, and rejects edits to `CHANGELOG.md` unless the PR has the `changelog:release` label. Maintainers may apply `changelog:skip` when notes are unnecessary, or `changelog:release` for release preparation. These labels, like Dependabot PRs, are exempt from the requirement, but never from fragment validation. Reviewers decide whether the chosen category is appropriate.
21
+
22
+
`yarn changelog:preview` prints pending fragments grouped by category, newest PR first, without changing files. It does not include entries already in `CHANGELOG.md`.
23
+
24
+
During release preparation, run `yarn changelog:release`. It verifies that the first version heading matches `package.json` and is unreleased, validates every fragment before writing, adds fragments above the existing entries of each section, newest PR first, removes `(Unreleased)`, and deletes consumed files. Review and commit all changes in the release PR. Historical entries and existing unreleased notes are preserved. Releases with no fragments can still finalize existing notes. The publish workflow refuses to release while fragments remain in `changes/`. If fragments are merged after the release PR but before publishing, run `yarn changelog:release` again: as long as Publish has not created the version's `v<version>` tag, it adds them to the finalized version. Once the tag exists, it refuses, and the fragments wait for the next version after `yarn changelog:open`. With no fragments left, running it again fails. Don't run it while a Publish run is in progress, because the tag only appears once that run gets to tagging, and the notes could then describe changes the run is not publishing.
25
+
26
+
After publishing, run `yarn changelog:open` once `package.json` has the next version. It adds an empty unreleased section with every category heading.
27
+
28
+
Only release preparation and opening the next unreleased section should edit `CHANGELOG.md`, in PRs labelled `changelog:release`. Keep fragments on the branch containing the associated change; backports should include their fragments if they need notes in the maintenance release.
0 commit comments