Skip to content

Commit 8066369

Browse files
authored
Updates changelog casing for release pipelines (#5212)
1 parent 1b19024 commit 8066369

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

cli/azd/docs/extension-framework.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ Usage: `azd x release --repo {owner}/{name}`
225225
- `--title, -t` - The name of the release, defaults to extension name plus version.
226226
- `--prerelease` - When set marks the release as a prerelease.
227227
- `--draft, -d` - When set marks the release a draft
228-
- `--notes, -n` - The release notes for the release, defaults to using contents of `changelog.md` within extension directory.
228+
- `--notes, -n` - The release notes for the release, defaults to using contents of `CHANGELOG.md` within extension directory.
229229
- `--version, -v` - The version of the release, defaults to extension version from extension manifest
230230
- `--confirm` - When set bypasses confirmation prompts before release
231231

@@ -251,7 +251,7 @@ contoso.azd.samples.<language>/
251251
├── bin/ # Contains built binaries
252252
├── build.ps1 # Windows build script
253253
├── build.sh # Unix build script
254-
├── changelog.md # Version history and release notes
254+
├── CHANGELOG.md # Version history and release notes
255255
├── extension.yaml # Extension metadata and capabilities
256256
├── README.md # Documentation for your extension
257257
└── <language-specific> # Source code files specific to the chosen language
@@ -260,7 +260,7 @@ contoso.azd.samples.<language>/
260260
Key files in the extension structure:
261261

262262
- **extension.yaml**: Defines metadata, capabilities, and commands for your extension
263-
- **changelog.md**: Documents changes between versions (used for release notes)
263+
- **CHANGELOG.md**: Documents changes between versions (used for release notes)
264264
- **build scripts**: Language-specific scripts for building your extension
265265

266266
Each supported language has a slightly different structure:
@@ -306,7 +306,7 @@ Managing versions of your extension is an important part of the development proc
306306
- Follow [Semantic Versioning](https://semver.org/) (MAJOR.MINOR.PATCH)
307307

308308
2. **Document Changes**:
309-
- Update your `changelog.md` with details about what's new or fixed
309+
- Update your `CHANGELOG.md` with details about what's new or fixed
310310
- Include any breaking changes or migration notes
311311

312312
3. **Build, Package and Test**:
@@ -331,7 +331,7 @@ Managing versions of your extension is an important part of the development proc
331331
- **Minor Version Changes (1.0.0 → 1.1.0)**: Adds new features while maintaining backward compatibility
332332
- **Patch Version Changes (1.0.0 → 1.0.1)**: Includes bug fixes with no feature changes
333333

334-
When upgrading across major versions, users may need to adapt to API changes. Document these changes clearly in your `changelog.md`.
334+
When upgrading across major versions, users may need to adapt to API changes. Document these changes clearly in your `CHANGELOG.md`.
335335

336336
### GitHub Authentication Requirements
337337

cli/azd/extensions/microsoft.azd.extensions/internal/cmd/release.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -167,13 +167,13 @@ func runReleaseAction(ctx context.Context, flags *releaseFlags) error {
167167
}
168168
}
169169

170-
// Automatically include changelog.md if no notes are provided
170+
// Automatically include CHANGELOG.md if no notes are provided
171171
if flags.notes == "" {
172-
fileInfo, err := os.Stat("changelog.md")
172+
fileInfo, err := os.Stat("CHANGELOG.md")
173173
if err == nil && !fileInfo.IsDir() {
174-
notes, err := os.ReadFile("changelog.md")
174+
notes, err := os.ReadFile("CHANGELOG.md")
175175
if err != nil {
176-
return fmt.Errorf("failed to read notes from changelog.md: %w", err)
176+
return fmt.Errorf("failed to read notes from CHANGELOG.md: %w", err)
177177
}
178178
flags.notes = string(notes)
179179
}

0 commit comments

Comments
 (0)