chore: updates to changesets workflow #14559
Merged
+251
−56
Conversation
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
|
sarah11918
reviewed
Oct 17, 2025
| - IMPORTANT: Ensure there is a newline before and after the code blocks in your feedback. Having triple backticks on the same line as other text WILL cause rendering issues. | ||
| - ALWAYS check your feedback for proper markdown formatting, particularly code fences and backticks. | ||
| - Use markdown codeblocks with triple backticks: 'yaml' for YAML examples, 'markdown' for changeset body examples | ||
| - IMPORTANT: Ensure there is a newline before and after code blocks. Triple backticks on the same line as other text WILL cause rendering issues |
There was a problem hiding this comment.
Just noting that it's not uncommon for us to have triple backticks and diff on the same line! (Niche case, but not sure whether worth mentioning here)
sarah11918
approved these changes
Oct 17, 2025
ematipico
reviewed
Oct 17, 2025
Comment on lines
+17
to
+18
| ✓ Correct: "Fixes", "Adds", "Updates", "Removes" | ||
| ✗ Incorrect: "Fix", "Add", "Update", "Remove", "Fixed", "Added" |
There was a problem hiding this comment.
Do symbols really help here? Geniune question
Comment on lines
+46
to
+63
| ```markdown | ||
| --- | ||
| 'astro': minor | ||
| --- | ||
|
|
||
| Adds support for custom error pages in middleware. You can now return a custom error response: | ||
|
|
||
| \`\`\`js | ||
| export function onRequest(context, next) { | ||
| if (!context.locals.user) { | ||
| return new Response('Unauthorized', { status: 401 }); | ||
| } | ||
| return next(); | ||
| } | ||
| \`\`\` | ||
| ``` | ||
|
|
||
| ```markdown |
There was a problem hiding this comment.
Very hard to provide a suggestion with markdown and UI, but usually here you can create "nested" code blocks:
``````md
## Heading
```js
const foo = "bar";
```
```````| - name: Set up Node.js | ||
| uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0 | ||
| with: | ||
| node-version: '20' |
There was a problem hiding this comment.
Suggested change
| node-version: '20' | |
| node-version: 'lts/*' |
So we don't need to update it
Comment on lines
+235
to
+276
| # Check for shallow headings in each changeset | ||
| echo "::debug::Checking for shallow headings (h1, h2, h3) in changesets" | ||
| while IFS= read -r file; do | ||
| if [ -f "$file" ]; then | ||
| # Make path absolute for the script | ||
| abs_file="$(pwd)/$file" | ||
| # Run the script and capture output | ||
| if heading_output=$(pnpm --filter astro-scripts has-shallow-headings "$abs_file" 2>&1); then | ||
| echo "::debug::$file: No shallow headings found" | ||
| else | ||
| # Filter output to only lines that look like markdown headings (start with #) | ||
| # This removes pnpm wrapper noise | ||
| heading_output=$(pnpm --filter astro-scripts has-shallow-headings "$abs_file" 2>&1 | grep '^#' || true) | ||
| if [ -n "$heading_output" ]; then | ||
| echo "::warning::$file: Contains forbidden shallow headings" | ||
| # Add heading errors to the validation response | ||
| # The script outputs the offending headings, one per line | ||
| while IFS= read -r heading; do | ||
| if [ -n "$heading" ]; then | ||
| error_msg="Forbidden heading found: '$heading'. Headings shallower than h4 (####) break changelog formatting. Please use h4 or deeper." | ||
| echo "::debug::Adding heading error for $file: $heading" | ||
| # Add error to the file's general_errors array in the JSON | ||
| jq --arg file "$file" --arg error "$error_msg" ' | ||
| .overall_valid = false | | ||
| .files |= map( | ||
| if .file == $file then | ||
| .valid = false | | ||
| .general_errors += [$error] | ||
| else . end | ||
| ) | ||
| ' validation_response.json > validation_response.tmp.json | ||
| mv validation_response.tmp.json validation_response.json | ||
| fi | ||
| done <<< "$heading_output" | ||
| else | ||
| echo "::debug::$file: Script failed but no headings found (might be other error)" | ||
| fi | ||
| fi | ||
| fi | ||
| done < changeset_files.txt |
There was a problem hiding this comment.
I wonder if it's best to have a JS script instead. I doubt any of us will be able to maintain it
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.
Changes
Testing
Tested on a branch using
pull_request, before switching topull_request_targetfor this PR. As ever withpull_request_targetPRs, this part will only be tested when it's actually merged and a new PR opened. Here's the PR with test changesets and comments: ascorbic#2Example of the output:
Docs