github/changelog: Dry-run changie merge & mention changie new (#36497)

radeksimko · web-flow · commit e0661f44ae6f · 2025-02-13T13:01:21.000Z
* github/changelog: Dry-run changie merge

* Mention 'changie new' command in comments
diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml
@@ -137,14 +137,16 @@ jobs:
                 return;
             }
             
+            const changieInstruction = 'You can use [`changie new`](https://changie.dev/cli/changie_new/) (without flags) to generate it. ';
+            
             if (backportLabel) {
                 if (unreleasedChangesPresent) {
                     await createOrUpdateChangelogComment("Please move the changelog entry from `./.changes/unreleased` to `./.changes/backported` for this change. If you believe this change does not need a changelog entry, please add the 'no-changelog-needed' label.");
                     return;
                 }
                 
                 if (!backportedChangesPresent) {
-                    await createOrUpdateChangelogComment("Please add a changelog entry to `./.changes/backported` for this change. If you believe this change does not need a changelog entry, please add the 'no-changelog-needed' label.");
+                    await createOrUpdateChangelogComment("Please add a changelog entry to `./.changes/backported` for this change. "+ changieInstruction +"If you believe this change does not need a changelog entry, please add the 'no-changelog-needed' label.");
                     return;
                 }
             } else {
@@ -154,10 +156,15 @@ jobs:
                 }
 
                 if (!unreleasedChangesPresent) {
-                    await createOrUpdateChangelogComment("Please add a changelog entry to `./.changes/unreleased` for this change. If you believe this change does not need a changelog entry, please add the 'no-changelog-needed' label.");
+                    await createOrUpdateChangelogComment("Please add a changelog entry to `./.changes/unreleased` for this change. "+ changieInstruction +"If you believe this change does not need a changelog entry, please add the 'no-changelog-needed' label.");
                     return;
                 }
             }
 
             // Nothing to complain about, so delete any existing comment
             await createOrUpdateChangelogComment("", true);
+      - name: Validate changie fragment is valid
+        uses: miniscruff/changie-action@6dcc2533cac0495148ed4046c438487e4dceaa23 # v2.0.0
+        with:
+          version: latest
+          args: merge --dry-run

Original file line number	Diff line number	Diff line change
`@@ -137,14 +137,16 @@ jobs:`
`137`	`137`	`return;`
`138`	`138`	`}`
`139`	`139`
	`140`	+ const changieInstruction = 'You can use [`changie new`](https://changie.dev/cli/changie_new/) (without flags) to generate it. ';
	`141`	`+`
`140`	`142`	`if (backportLabel) {`
`141`	`143`	`if (unreleasedChangesPresent) {`
`142`	`144`	await createOrUpdateChangelogComment("Please move the changelog entry from `./.changes/unreleased` to `./.changes/backported` for this change. If you believe this change does not need a changelog entry, please add the 'no-changelog-needed' label.");
`143`	`145`	`return;`
`144`	`146`	`}`
`145`	`147`
`146`	`148`	`if (!backportedChangesPresent) {`
`147`		- await createOrUpdateChangelogComment("Please add a changelog entry to `./.changes/backported` for this change. If you believe this change does not need a changelog entry, please add the 'no-changelog-needed' label.");
	`149`	+ await createOrUpdateChangelogComment("Please add a changelog entry to `./.changes/backported` for this change. "+ changieInstruction +"If you believe this change does not need a changelog entry, please add the 'no-changelog-needed' label.");
`148`	`150`	`return;`
`149`	`151`	`}`
`150`	`152`	`} else {`
`@@ -154,10 +156,15 @@ jobs:`
`154`	`156`	`}`
`155`	`157`
`156`	`158`	`if (!unreleasedChangesPresent) {`
`157`		- await createOrUpdateChangelogComment("Please add a changelog entry to `./.changes/unreleased` for this change. If you believe this change does not need a changelog entry, please add the 'no-changelog-needed' label.");
	`159`	+ await createOrUpdateChangelogComment("Please add a changelog entry to `./.changes/unreleased` for this change. "+ changieInstruction +"If you believe this change does not need a changelog entry, please add the 'no-changelog-needed' label.");
`158`	`160`	`return;`
`159`	`161`	`}`
`160`	`162`	`}`
`161`	`163`
`162`	`164`	`// Nothing to complain about, so delete any existing comment`
`163`	`165`	`await createOrUpdateChangelogComment("", true);`
	`166`	`+ - name: Validate changie fragment is valid`
	`167`	`+ uses: miniscruff/changie-action@6dcc2533cac0495148ed4046c438487e4dceaa23 # v2.0.0`
	`168`	`+ with:`
	`169`	`+ version: latest`
	`170`	`+ args: merge --dry-run`