Skip to content

Commit 91dc23e

Browse files
kvapskvaps
authored
docs(changelog): add v1.3.0-rc.1 changelog and update agent instructions (#2410)
## What this PR does Adds the v1.3.0-rc.1 release changelog covering all changes since v1.2.0, and updates the changelog agent instructions to include two new side repositories. **Changelog** (`docs/changelogs/v1.3.0-rc.1.md`): - Feature Highlights: storage-aware scheduling, LINSTOR GUI, VM Default Images, WorkloadsReady conditions, cross-namespace VM backup restore - Covers main repo, website, talm, ansible-cozystack, and external-apps-example changes - Backported fixes marked with *(backported to v1.2.x)* annotation **Agent instructions** (`docs/agents/changelog.md`): - Adds `external-apps-example` and `ansible-cozystack` to the optional repositories list ### Screenshots N/A — documentation only. ### Release note ```release-note docs(changelog): add changelog for v1.3.0-rc.1 ```
2 parents d9657bc + 1e1bb3e commit 91dc23e

2 files changed

Lines changed: 181 additions & 6 deletions

File tree

‎docs/agents/changelog.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ When the user asks to generate a changelog, follow these steps in the specified
2222
- [ ] Step 5: Get the list of commits for the release period
2323
- [ ] Step 6: Check additional repositories (website is REQUIRED, optional repos if tags exist)
2424
- [ ] **MANDATORY**: Check website repository for documentation changes WITH authors and PR links via GitHub CLI
25-
- [ ] **MANDATORY**: Check ALL optional repositories (talm, boot-to-talos, cozyhr, cozy-proxy) for tags during release period
25+
- [ ] **MANDATORY**: Check ALL optional repositories (talm, boot-to-talos, cozyhr, cozy-proxy, external-apps-example, ansible-cozystack) for tags during release period
2626
- [ ] **MANDATORY**: For ALL commits from additional repos, get GitHub username via CLI, prioritizing PR author over commit author.
2727
- [ ] Step 7: Analyze commits (extract PR numbers, authors, user impact)
2828
- [ ] **MANDATORY**: For EVERY PR in main repo, get PR author via `gh pr view <PR_NUMBER> --json author --jq .author.login` (do NOT skip this step)
@@ -148,6 +148,8 @@ Cozystack release may include changes from related repositories. Check and inclu
148148
- [https://github.com/cozystack/boot-to-talos](https://github.com/cozystack/boot-to-talos)
149149
- [https://github.com/cozystack/cozyhr](https://github.com/cozystack/cozyhr)
150150
- [https://github.com/cozystack/cozy-proxy](https://github.com/cozystack/cozy-proxy)
151+
- [https://github.com/cozystack/external-apps-example](https://github.com/cozystack/external-apps-example)
152+
- [https://github.com/cozystack/ansible-cozystack](https://github.com/cozystack/ansible-cozystack)
151153

152154
**⚠️ IMPORTANT**: You MUST check ALL optional repositories for tags created during the release period. Do NOT skip this step even if you think there might not be any tags. Use the process below to verify.
153155

@@ -195,7 +197,7 @@ Cozystack release may include changes from related repositories. Check and inclu
195197

196198
3. **For optional repositories, check if tags exist during release period:**
197199

198-
**⚠️ MANDATORY: You MUST check ALL optional repositories (talm, boot-to-talos, cozyhr, cozy-proxy). Do NOT skip any repository!**
200+
**⚠️ MANDATORY: You MUST check ALL optional repositories (talm, boot-to-talos, cozyhr, cozy-proxy, external-apps-example, ansible-cozystack). Do NOT skip any repository!**
199201

200202
**Use the helper script:**
201203
```bash
@@ -208,7 +210,7 @@ Cozystack release may include changes from related repositories. Check and inclu
208210
```
209211

210212
The script will:
211-
- Check ALL optional repositories (talm, boot-to-talos, cozyhr, cozy-proxy)
213+
- Check ALL optional repositories (talm, boot-to-talos, cozyhr, cozy-proxy, external-apps-example, ansible-cozystack)
212214
- Look for tags created during the release period
213215
- Get commits between tags (if tags exist) or by date range (if no tags)
214216
- Extract PR numbers from commit messages
@@ -569,7 +571,7 @@ Create a new changelog file in the format matching previous versions:
569571
- [ ] Step 5 completed: **ALL commits included** (including merge commits and backports) - do not skip any commits
570572
- [ ] Step 5 completed: **Backports identified and handled correctly** - original PR author used, both original and backport PR numbers included
571573
- [ ] Step 6 completed: Website repository checked for documentation changes WITH authors and PR links via GitHub CLI
572-
- [ ] Step 6 completed: **ALL** optional repositories (talm, boot-to-talos, cozyhr, cozy-proxy) checked for tags during release period
574+
- [ ] Step 6 completed: **ALL** optional repositories (talm, boot-to-talos, cozyhr, cozy-proxy, external-apps-example, ansible-cozystack) checked for tags during release period
573575
- [ ] Step 6 completed: For ALL commits from additional repos, GitHub username obtained via GitHub CLI (not skipped). For commits with PR numbers, PR author used via `gh pr view` (not commit author)
574576
- [ ] Step 7 completed: For EVERY PR in main repo (including backports), PR author obtained via `gh pr view <PR_NUMBER> --json author --jq .author.login` (not skipped or assumed). Commit author NOT used - always use PR author
575577
- [ ] Step 7 completed: **Backports verified** - for each backport PR, original PR found and original PR author used in changelog
@@ -628,7 +630,7 @@ Save the changelog to file `docs/changelogs/v<version>.md` according to the vers
628630
629631
- **Additional repositories (Step 6) - MANDATORY**:
630632
- **⚠️ CRITICAL**: Always check the **website** repository for documentation changes during the release period. This is a required step and MUST NOT be skipped.
631-
- **⚠️ CRITICAL**: You MUST check ALL optional repositories (talm, boot-to-talos, cozyhr, cozy-proxy) for tags during the release period. Do NOT skip any repository even if you think there might not be tags.
633+
- **⚠️ CRITICAL**: You MUST check ALL optional repositories (talm, boot-to-talos, cozyhr, cozy-proxy, external-apps-example, ansible-cozystack) for tags during the release period. Do NOT skip any repository even if you think there might not be tags.
632634
- **CRITICAL**: For ALL entries from additional repositories (website and optional), you MUST:
633635
- **MANDATORY**: Extract PR number from commit message first
634636
- **MANDATORY**: For commits with PR numbers, ALWAYS use `gh pr view <PR_NUMBER> --repo cozystack/<repo> --json author --jq .author.login` to get PR author (not commit author)
@@ -637,7 +639,7 @@ Save the changelog to file `docs/changelogs/v<version>.md` according to the vers
637639
- **MANDATORY**: Do NOT use commit author for PRs - always use PR author
638640
- Include PR link or commit hash reference
639641
- Format: `* **[repo] Description**: details ([**@username**](https://github.com/username) in cozystack/repo#123)`
640-
- For **optional repositories** (talm, boot-to-talos, cozyhr, cozy-proxy), you MUST check ALL of them for tags during the release period. Use the loop provided in Step 6 to check each repository systematically.
642+
- For **optional repositories** (talm, boot-to-talos, cozyhr, cozy-proxy, external-apps-example, ansible-cozystack), you MUST check ALL of them for tags during the release period. Use the loop provided in Step 6 to check each repository systematically.
641643
- When including changes from additional repositories, use the format: `[repo-name] Description` and link to the repository's PR/issue if available
642644
- **Prefer PR numbers over commit hashes**: For commits from additional repositories, extract PR number from commit message using GitHub API. Use PR format (`cozystack/website#123`) instead of commit hash (`cozystack/website@abc1234`) when available
643645
- **Never add entries without author and PR/commit reference**: Every entry from additional repositories must have both author and link

0 commit comments

Comments
 (0)