Skip to content

Commit 2c3bc5a

Browse files
CopilotJeffreyCA
andauthored
Prepare changelog for v1.18.0 release (#5489)
* Complete changelog for v1.18.0 release * Improve copilot-instructions.md Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: JeffreyCA <9157833+JeffreyCA@users.noreply.github.com>
1 parent 6fd30f4 commit 2c3bc5a

File tree

4 files changed

+37
-7
lines changed

4 files changed

+37
-7
lines changed

.github/copilot-instructions.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ Rename any existing `## 1.x.x-beta.1 (Unreleased)` section to the version being
205205
```bash
206206
git --no-pager log --grep="Increment CLI version" --invert-grep -n 3 --follow -p -- cli/azd/CHANGELOG.md
207207
```
208-
Look at the commit messages and diff output to identify the commit that added the previous version's changelog.
208+
Review the diff output to find the most recent commit that added the previous version's changelog - this is the cutoff commit. Focus on the actual changelog changes in the diff instead of the commit messages themselves.
209209

210210
**Get commits to process**:
211211
```bash
@@ -214,18 +214,27 @@ git --no-pager log --oneline --pretty=format:"%h (%ad) %s" --date=short -20 orig
214214
Increase `-20` if needed to find the cutoff commit. `git log` shows commits in reverse chronological order (newest first). You must identify the cutoff commit and only take commits newer than (above) it.
215215

216216
### Step 3: Gather context and write changelog entry
217-
**IMPORTANT: For EACH commit collected, do the following:**
217+
**CRITICAL INSTRUCTION: Process each commit individually and sequentially. Complete the full workflow (extract PR, fetch details, categorize, write entry, save) one entry at a time. DO NOT batch process multiple commits/PRs, skip PRs, or cut the process short due to time constraints.**
218218

219219
1. **Extract PR number**: Look for `(#XXXX)` pattern in commit message
220220
2. **Fetch PR details** using GitHub tools: owner: `Azure`, repo: `azure-dev`, pullNumber: `PR#`
221221
- Get the GitHub handle of the PR owner, and determine whether the owner is outside the core team (handle not in `.github/CODEOWNERS`)
222222
3. **Identify linked issues**: Scan PR details for GitHub issue references
223223
4. **Fetch linked issue details** using GitHub tools: owner: `Azure`, repo: `azure-dev`, issue_number: `XXXX`
224224
5. **Categorize change**: Features Added, Bugs Fixed, Other Changes
225-
6. **Write changelog entry**:
225+
6. **Add changelog entry to CHANGELOG.md**:
226226
- **Format**: `- [[PR#]](https://github.com/Azure/azure-dev/pull/PR#) User-friendly description.`
227-
- **Guidelines**: Be brief. Start with action verbs (Add, Fix, Update, etc.) and describe user impact. Follow existing changelog entries for style.
227+
- **Process**: Read PR description and linked issue carefully to understand the user impact
228+
- **Guidelines**:
229+
- Be brief. Start with action verbs (Add, Fix, Update, etc.) and describe user impact. Follow existing changelog entries for style.
230+
- For bugs, phrase the changelog entry in terms of the issue that was fixed when possible. Example: "Fix PowerShell 7 suggestion text not showing for service-level hooks."
228231
- **Attribution**: For PRs from contributors outside the core team, append: " Thanks @handle for the contribution!"
232+
7. **Exclude the following types of changes** from the changelog:
233+
- Test-related changes and test infrastructure updates
234+
- Documentation updates (README.md, .md files, CODEOWNERS)
235+
- Automated dependency bumps and CVE fixes that are purely dependency updates (updates to tools like Bicep CLI, GitHub CLI should remain in the changelog)
236+
- Internal refactoring, code cleanup, and variable renames without user impact
237+
- Build/release infrastructure and CI/CD pipeline changes
229238

230239
### Step 4: Organize and finalize
231240
1. **Remove empty categories** and **validate formatting**

.vscode/cspell-github-user-aliases.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ haoozhang
2222
isatty
2323
joho
2424
karolz
25+
kitsiosk
2526
LianwMS
2627
Lunatico9
2728
mattn

cli/azd/CHANGELOG.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,35 @@
11
# Release History
22

3-
## 1.18.0-beta.1 (Unreleased)
3+
## 1.18.0
44

55
### Features Added
66

7-
### Breaking Changes
7+
- [[5380]](https://github.com/Azure/azure-dev/pull/5380) Improve project name validation to prevent service packaging failures with invalid characters.
8+
- [[5411]](https://github.com/Azure/azure-dev/pull/5411) Add LLM package for AI functionality with auto-detection of LLM configuration.
9+
- [[5397]](https://github.com/Azure/azure-dev/pull/5397) Add support for generic OIDC authentication with any CI provider.
10+
- [[4832]](https://github.com/Azure/azure-dev/pull/4832) Improve user experience by prompting for confirmation before setting a new environment as the default.
11+
- [[5384]](https://github.com/Azure/azure-dev/pull/5384) Add support for boolean and integer default values in azd metadata fields.
12+
- [[5383]](https://github.com/Azure/azure-dev/pull/5383) Add support for `.webappignore` and `.funcignore` files in zip deployment packaging.
13+
- [[5430]](https://github.com/Azure/azure-dev/pull/5430) Update `azd hooks run` to always run hooks in interactive mode and improve schema validation.
814

915
### Bugs Fixed
1016

17+
- [[5478]](https://github.com/Azure/azure-dev/pull/5478) Fix panic when encountering Bicep secure output parameters.
18+
- [[5468]](https://github.com/Azure/azure-dev/pull/5468) Fix PowerShell 7 suggestion text not showing for service-level hooks.
19+
- [[5470]](https://github.com/Azure/azure-dev/pull/5470) Fix preflight error handling for deployment stack validation.
20+
- [[5446]](https://github.com/Azure/azure-dev/pull/5446) Fix Bicep parameter evaluation to properly inject environment variables before deployment.
21+
- [[5459]](https://github.com/Azure/azure-dev/pull/5459) Fix nil pointer error when checking credentials for Azure DevOps authentication.
22+
- [[5434]](https://github.com/Azure/azure-dev/pull/5434) Improve handling of unrecognized expressions in Aspire manifest files.
23+
- [[5372]](https://github.com/Azure/azure-dev/pull/5372) Fix null tags handling in deployment stack operations.
24+
1125
### Other Changes
1226

27+
- [[5471]](https://github.com/Azure/azure-dev/pull/5471) Cancel CI workflow that becomes obsolete after a new commit is pushed in an open PR. Thanks @kitsiosk for the contribution!
28+
- [[5420]](https://github.com/Azure/azure-dev/pull/5420) Improve help description for `azd provision --no-state`.
29+
- [[5378]](https://github.com/Azure/azure-dev/pull/5378) Add Microsoft.Automation/automationAccounts to resources for output.
30+
- [[5461]](https://github.com/Azure/azure-dev/pull/5461) Update GitHub CLI version to 2.75.1.
31+
- [[5443]](https://github.com/Azure/azure-dev/pull/5443) Update Bicep CLI version to 0.36.177.
32+
1333
## 1.17.2 (2025-06-23)
1434

1535
### Bugs Fixed

cli/version.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.18.0-beta.1
1+
1.18.0

0 commit comments

Comments
 (0)