Skip to content

Commit 4ba14ae

Browse files
committed
chore: clean markdownlint issues in preview/RC automation prompt files
1 parent 801a339 commit 4ba14ae

File tree

2 files changed

+31
-35
lines changed

2 files changed

+31
-35
lines changed

.github/prompts/createprs-for-preview.prompt.md

Lines changed: 23 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -34,33 +34,29 @@ Example (NOT to be edited into the file): DOTNET_VERSION=10, MILESTONE_KIND=rc,
3434
## Process (assistant substitutes variables at execution time)
3535

3636
1. Create a new branch from the base branch: `git switch -c dotnet${DOTNET_VERSION}-${MilestonePrefix}-{name} origin/dotnet${DOTNET_VERSION}-${MilestonePrefix}`
37-
1. Modify the file content:
38-
- If the file contains a neutral/no-new-features sentence such as:
39-
* `This ${Milestone Label} release does not contain new` … OR
40-
* `This RC 2 release does not contain new`
41-
replace that ENTIRE sentence block with the following scaffold (customize the product/area name appropriately — keep heading anchors lowercase with hyphens):
42-
```markdown
43-
Here's a summary of what's new in <Product/Area> in this ${Milestone Label} release:
44-
45-
- [Feature](#feature)
46-
47-
## Feature
48-
49-
Feature summary
50-
```
51-
- Otherwise, insert the above placeholder text directly below the heading.
52-
- Do NOT append duplicates; always replace in-place.
37+
1. Modify the file content. If the file contains a neutral/no-new-features sentence such as `This ${Milestone Label} release does not contain new ...` (or the equivalent for a specific RC) replace that entire sentence block with the scaffold below. If no neutral sentence exists, insert the scaffold directly below the heading (only once; do not duplicate it).
38+
39+
```markdown
40+
Here's a summary of what's new in <Product/Area> in this ${Milestone Label} release:
41+
42+
- [Feature](#feature)
43+
44+
## Feature
45+
46+
Feature summary
47+
```
48+
5349
1. Run markdown lint: `npx markdownlint --config .github/linters/.markdown-lint.yml release-notes/${DOTNET_VERSION}.0/preview/${MilestonePrefix}/{name}`
5450
1. Commit: `Update {name} for ${Milestone Label}`
5551
1. Push the branch
56-
1. Create a pull request with:
57-
- Title: `Update {name} for ${Milestone Label}`
58-
- Body (exact format):
59-
```
60-
Please update the release notes here as needed for ${Milestone Label}.
61-
62-
/cc @{assignees}
63-
```
52+
1. Create a pull request with title `Update {name} for ${Milestone Label}` and body:
53+
54+
```text
55+
Please update the release notes here as needed for ${Milestone Label}.
56+
57+
/cc @{assignees}
58+
```
59+
6460
1. Assign the PR (first listed person if multiple): `gh pr edit <PR_NUMBER> --add-assignee <username>`
6561
1. Switch back to `dotnet${DOTNET_VERSION}-${MilestonePrefix}` and continue with the next file.
6662

@@ -114,11 +110,11 @@ Here are the files to process one at a time:
114110
After all component PRs are opened for the milestone, create a consolidation PR:
115111

116112
1. Source: `dotnet${DOTNET_VERSION}-${MilestonePrefix}` → Target: `main`
117-
1. Title: `Add release notes for .NET ${DOTNET_VERSION} ${Milestone Label} across various components`
118-
1. Body sections:
113+
2. Title: `Add release notes for .NET ${DOTNET_VERSION} ${Milestone Label} across various components`
114+
3. Body sections:
119115
- Intro sentence
120116
- Bullet list of component PRs (e.g. `- ASP.NET Core: #<PR>`)
121117
- CC release management (e.g. `@leecow @rbhanda @victorisr`)
122-
1. Match the structure used previously (see Preview 7 consolidation PR #10006) for consistency.
118+
4. Match the structure used previously (see Preview 7 consolidation PR #10006) for consistency.
123119

124120
When adapting for another milestone, update only the branch name, title milestone label, and intro sentence.

.github/prompts/scaffoldpreview.prompt.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@ Example (not baked in): DOTNET_VERSION=10, MILESTONE_KIND=rc, MILESTONE_NUMBER=2
2222
## Steps
2323

2424
1. Navigate to `release-notes/${DOTNET_VERSION}.0/preview/`.
25-
2. Duplicate the previous milestone folder (prior prefix → new prefix, e.g. `rc1``${MilestonePrefix}` or `p6``${MilestonePrefix}`).
26-
3. Remove (do NOT copy):
27-
- `api-diff` directory (if present) – will be regenerated later.
28-
- `release.json` – create a fresh one if required by process.
29-
4. For each component markdown file, update the heading and milestone label only; preserve existing anchor structure.
30-
5. If there are no new feature items yet, insert a neutral placeholder sentence (e.g. `This ${Milestone Label} release does not introduce new ${Product} features.`) instead of a generic "Something about the feature" line. Avoid duplicating placeholder lines.
31-
6. Run markdown lint: `npx markdownlint --config .github/linters/.markdown-lint.yml release-notes/${DOTNET_VERSION}.0/preview/${MilestonePrefix}/*.md`.
32-
7. Commit on the base milestone branch (`dotnet${DOTNET_VERSION}-${MilestonePrefix}`) with message: `Scaffold .NET ${DOTNET_VERSION} ${Milestone Label} release notes folder`.
25+
1. Duplicate the previous milestone folder (prior prefix → new prefix, e.g. `rc1``${MilestonePrefix}` or `p6``${MilestonePrefix}`).
26+
1. Remove (do NOT copy):
27+
- `api-diff` directory (if present) – will be regenerated later.
28+
- `release.json` – create a fresh one if required by process.
29+
1. For each component markdown file, update the heading and milestone label only; preserve existing anchor structure.
30+
1. If there are no new feature items yet, insert a neutral placeholder sentence (e.g. `This ${Milestone Label} release does not introduce new ${Product} features.`) instead of a generic "Something about the feature" line. Avoid duplicating placeholder lines.
31+
1. Run markdown lint: `npx markdownlint --config .github/linters/.markdown-lint.yml release-notes/${DOTNET_VERSION}.0/preview/${MilestonePrefix}/*.md`.
32+
1. Commit on the base milestone branch (`dotnet${DOTNET_VERSION}-${MilestonePrefix}`) with message: `Scaffold .NET ${DOTNET_VERSION} ${Milestone Label} release notes folder`.
3333

3434
## Sample File Template (aspnetcore.md – dynamic)
3535

0 commit comments

Comments
 (0)