Skip to content

Commit 3c87de4

Browse files
Copilotchrisrueger
andcommitted
Add wiki integration instructions for patch release documentation
Provide clear instructions for adding the patch release documentation to the GitHub wiki, including recommended placement and content highlights. Co-authored-by: chrisrueger <188422+chrisrueger@users.noreply.github.com>
1 parent 39e5397 commit 3c87de4

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Patch Release Documentation - Wiki Integration Instructions
2+
3+
This document provides instructions for adding the patch release documentation to the GitHub wiki.
4+
5+
## File Location
6+
7+
The patch release documentation has been created in this repository at:
8+
`docs/patch-release-documentation.md`
9+
10+
## Integration into Wiki
11+
12+
The content from `docs/patch-release-documentation.md` should be added to the GitHub wiki at:
13+
https://github.com/bndtools/bnd/wiki/Release-Process
14+
15+
### Recommended Integration Approach
16+
17+
Add a new section to the Release Process wiki page titled:
18+
19+
**"Patch Release Process (MICRO Version Increase)"**
20+
21+
This section should be inserted after the "RC2..." section and before the "Release" section, or as a standalone section at the end of the page with a link in the table of contents.
22+
23+
### Alternative Approach
24+
25+
Create a separate wiki page:
26+
- Page name: "Patch-Release-Process"
27+
- Link from the main Release Process page
28+
29+
### Content Highlights
30+
31+
The patch release documentation covers:
32+
33+
1. **When to Use Patch Releases** - Guidelines for when a patch release is appropriate
34+
2. **Key Differences from Regular Releases** - Important distinctions including:
35+
- Master branch is NOT updated
36+
- RC1 builds with previous release (not RC range)
37+
- RC2+ builds with RC range
38+
- About.java gets patch version constant with 3 components
39+
3. **Preparation for First Patch Release Candidate** - Complete step-by-step instructions
40+
4. **Subsequent Patch Release Candidates** - Instructions for RC2, RC3, etc.
41+
5. **Final Patch Release** - Reference to existing release documentation
42+
6. **Complete Workflow Example** - A full example workflow from start to finish
43+
44+
### Wiki Update Instructions
45+
46+
To add this to the wiki:
47+
48+
1. Go to https://github.com/bndtools/bnd/wiki/Release-Process/_edit
49+
2. Choose where to insert the patch release section (recommended: near the end, after RC2 section)
50+
3. Copy the content from `docs/patch-release-documentation.md`
51+
4. Paste it into the wiki editor
52+
5. Adjust any formatting or links as needed
53+
6. Save the page
54+
55+
Alternatively, create a new wiki page:
56+
1. Go to https://github.com/bndtools/bnd/wiki/_new
57+
2. Title: "Patch-Release-Process"
58+
3. Paste content from `docs/patch-release-documentation.md`
59+
4. Save
60+
5. Add a link to this page from the main Release Process page
61+
62+
## Testing the Documentation
63+
64+
The documentation has been tested with dry-run mode for the following scenarios:
65+
- patch-first-rc for 7.2.1-RC1 (builds with [7.2.0,7.3.0))
66+
- patch-next-rc for 7.2.1-RC2 (builds with [7.2.1-RC,7.3.0))
67+
- release for 7.2.1 (final release)
68+
- Validation that patch modes reject MICRO version = 0
69+
70+
All tests passed successfully.

0 commit comments

Comments
 (0)