Skip to content

Commit 7e5bb33

Browse files
committed
docs: add automatic issue closing instructions to release process
- Add GitHub keywords (Closes, Fixes, Resolves) to release notes template - Add issue references to merge commit example - Add 'Automatic Issue Closing' section with keyword reference - Document multiple issue closing syntax
1 parent 4d9eb5c commit 7e5bb33

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

.github/copilot-instructions.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,10 @@ git checkout main
204204
git pull origin main
205205
206206
# Merge feature branch (use --no-ff to preserve history)
207-
git merge --no-ff feature/vX.Y.Z-branch-name -m "Merge feature/vX.Y.Z-branch-name: Brief description"
207+
# Include issue references to auto-close them
208+
git merge --no-ff feature/vX.Y.Z-branch-name -m "Merge feature/vX.Y.Z-branch-name: Brief description
209+
210+
Closes #XX, Closes #YY"
208211
209212
# Push to main
210213
git push origin main
@@ -247,15 +250,17 @@ git push origin vX.Y.Z
247250

248251
#### 7. Create GitHub Release
249252

253+
**IMPORTANT**: Use GitHub keywords to automatically close related issues. Include `Closes #X`, `Fixes #X`, or `Resolves #X` in the release notes for each issue addressed.
254+
250255
```powershell
251256
# Create release with plugin package attached
252257
gh release create vX.Y.Z "release/com.pedrofuentes.ical.streamDeckPlugin" `
253258
--title "vX.Y.Z - Release Title" `
254259
--notes "## What's New
255260
256-
- ✨ Feature 1
257-
- ✨ Feature 2
258-
- 🐛 Bug fix 1
261+
- ✨ Feature 1 (Closes #XX)
262+
- ✨ Feature 2 (Closes #YY)
263+
- 🐛 Bug fix 1 (Fixes #ZZ)
259264
260265
## Installation
261266
@@ -266,10 +271,24 @@ Or create manually on GitHub:
266271
1. Go to https://github.com/pedrofuentes/stream-deck-ical/releases/new
267272
2. Choose the tag `vX.Y.Z`
268273
3. Set release title
269-
4. Add release notes
274+
4. Add release notes with `Closes #X` or `Fixes #X` for each issue
270275
5. Attach `release/com.pedrofuentes.ical.streamDeckPlugin`
271276
6. Publish release
272277

278+
### Automatic Issue Closing
279+
280+
GitHub automatically closes issues when these keywords are used in:
281+
- **Commit messages** merged to main: `git commit -m "feat: add feature X (Closes #123)"`
282+
- **PR descriptions**: Include `Closes #123` in the PR body
283+
- **Release notes**: Issues are closed when the release is published
284+
285+
**Keywords** (case-insensitive):
286+
- `Closes #X` / `Close #X`
287+
- `Fixes #X` / `Fix #X`
288+
- `Resolves #X` / `Resolve #X`
289+
290+
**Multiple issues**: `Closes #11, Closes #20` or `Fixes #11, #20`
291+
273292
#### 8. Post-Release Cleanup
274293

275294
```powershell

0 commit comments

Comments
 (0)