Skip to content

Commit 7d5a31c

Browse files
committed
Update Major and Minor Releases titles and text
So it's clearer which page we are on and make them consistent together. Also remove trailing whitespace.
1 parent bcff6a1 commit 7d5a31c

File tree

2 files changed

+8
-9
lines changed

2 files changed

+8
-9
lines changed

technical/MajorRelease.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
layout: default
33
---
44

5-
# Stages
5+
# Major Releases
66

7-
Each release goes through the following milestones and stages:
7+
Each major release goes through the following milestones and stages:
88

99
## Announcement Preparation
1010

@@ -16,7 +16,7 @@ A release may be triggered for several reasons.
1616
Whatever the reason, the first step in the determination by the maintainers that a release is needed.
1717

1818
The maintainers will create a Github project to track the release.
19-
The maintainers will schedule a meeting to review outstanding Pull Requests.
19+
The maintainers will schedule a meeting to review outstanding Pull Requests.
2020

2121

2222
## Announcment milestone
@@ -55,7 +55,7 @@ After the PR Merge phase, only bug-fix PRs will be merged.
5555

5656
## Release Candidates
5757

58-
After all outstanding PRs are merged and all critical bugs are resolved, a Release Candidate (RC) version will be created and a public announcment made. This is a request to the community for intentional and deliberate testing with the goal of uncovering as many bugs as possible. This is the point at which the formal branch is created for the releases. First, create a branch called "releases/FreeCAD-X-Y" where X and Y are the major and minor release numbers. Next use the GitHub "Draft new release" button on the Releases page to create a new release. Set it up to create a new tag with the release number in it, e.g. "0.21rc1" and ensure that the release is based on the "releases/FreeCAD-X-Y" branch. Mark the release as a "pre-release" so that it does not display as the latest version. Attach all of the necessary installers, appimages, packages, etc. to this release. Note that the release can be edited after creation, so assets can be added as they become available.
58+
After all outstanding PRs are merged and all critical bugs are resolved, a Release Candidate (RC) version will be created and a public announcment made. This is a request to the community for intentional and deliberate testing with the goal of uncovering as many bugs as possible. This is the point at which the formal branch is created for the releases. First, create a branch called "releases/FreeCAD-X-Y" where X and Y are the major and minor release numbers. Next use the GitHub "Draft new release" button on the Releases page to create a new release. Set it up to create a new tag with the release number in it, e.g. "0.21rc1" and ensure that the release is based on the "releases/FreeCAD-X-Y" branch. Mark the release as a "pre-release" so that it does not display as the latest version. Attach all of the necessary installers, appimages, packages, etc. to this release. Note that the release can be edited after creation, so assets can be added as they become available.
5959

6060
Translation files will be pushed to CrowdIn and a public call for translation assistance should be made.
6161

technical/MinorRelease.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
layout: default
33
---
44

5+
# Minor Releases
6+
57
Between major releases, bugs are occasionally found and repaired. These fixes may be urgent enough or isolated enough that applying them incrementally to the existing ‘stable’ version is both possible and desirable. A set of such changes may be grouped together and released as a ‘minor’ version.
68

79
Usually these fixes have already been applied to the development branch. The process of applying them to the previous stable version is called 'backporting'
810

9-
## Stages
10-
1111
Each minor release goes through the following stages:
1212

1313
## Creation of Release Milestone
@@ -35,7 +35,6 @@ The backport PR will go through the same process as any other PR.
3535

3636
Minor bugs may be gathered together for a period of days or weeks to batch them together. A significant bug or one that risks user data may require an expedited release.
3737

38-
When the determination is made to proceed with the release, the following things happen"
38+
When the determination is made to proceed with the release, the following things happen:
3939

40-
1. something
41-
2. Something else
40+
<!-- ## TODO: ping maintainers to clarify procedure here -->

0 commit comments

Comments
 (0)