Skip to content

Commit 49ed549

Browse files
committed
docs(release): align title and tag naming conventions
1 parent 2a33bf9 commit 49ed549

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

.github/RELEASE_PROCESS.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ Use this process for:
1212
## 2. Release Inputs
1313

1414
Before starting, confirm:
15-
- target version (for example `v1.0.1`)
15+
- target release version `X.Y.Z`
16+
- release tag format: `vX.Y.Z`
17+
- release title format: `Version X.Y.Z`
1618
- release owner
1719
- included PRs/issues
1820
- intended release date/time
@@ -77,7 +79,8 @@ git push origin vX.Y.Z
7779
```
7880

7981
2. Create GitHub Release for that tag and publish release notes.
80-
3. Mark as `Latest` when appropriate.
82+
3. Set release title to exactly `Version X.Y.Z`.
83+
4. Mark as `Latest` when appropriate.
8184

8285
## 6. Post-Release Checks
8386

@@ -95,5 +98,5 @@ composer require MarketDataApp/sdk-php
9598
If release issues are discovered:
9699
1. Stop promotion messaging.
97100
2. Publish corrective note in release/changelog.
98-
3. Ship patch release (`vX.Y.Z+1`) from `main` with targeted fix.
101+
3. Ship a patch release (`vX.Y.(Z+1)`) from `main` with targeted fix.
99102
4. Document root cause and remediation in next changelog entry.

0 commit comments

Comments
 (0)