Skip to content

Commit c08dc11

Browse files
committed
Updated readme for v1.17.1
1 parent bf92d12 commit c08dc11

1 file changed

Lines changed: 23 additions & 23 deletions

File tree

‎Terminal.Gui/README.md‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ Doing so will update the `.csproj` files in your branch with version info, which
5151

5252
The following actions will publish the Terminal.Gui package to Nuget:
5353

54-
* A new version tag is defined and pushed to `main` - this is the normal release process.
55-
* A push to the `main` branch without a new version tag - this is a release-candidate build and will be of the form `1.2.3-rc.4`
56-
* A push to the `develop` branch - this is a pre-release build and will be of the form `1.2.3-pre.4`
54+
* A new version tag is defined and pushed to `v1_release` - this is the normal release process.
55+
* A push to the `v1_release` branch without a new version tag - this is a release-candidate build and will be of the form `1.2.3-rc.4`
56+
* A push to the `v1_develop` branch - this is a pre-release build and will be of the form `1.2.3-pre.4`
5757

5858
## Publishing a Release of Terminal.Gui
5959

@@ -71,17 +71,17 @@ The `tag` must be of the form `v<major>.<minor>.<patch>`, e.g. `v1.2.3`.
7171

7272
### 1) Verify the `develop` branch is ready for release
7373

74-
* Ensure everything is committed and pushed to the `develop` branch
75-
* Ensure your local `develop` branch is up-to-date with `upstream/develop`
74+
* Ensure everything is committed and pushed to the `v1_develop` branch
75+
* Ensure your local `v1_develop` branch is up-to-date with `upstream/v1_develop`
7676

77-
### 2) Create a pull request for the release in the `develop` branch
77+
### 2) Create a pull request for the release in the `v1_develop` branch
7878

7979
The PR title should be of the form "Release v1.2.3"
8080

8181
```powershell
82-
git checkout develop
83-
git pull upstream develop
84-
git checkout -b v2_3_4
82+
git checkout v1_develop
83+
git pull upstream v1_develop
84+
git checkout -b v1_2_3
8585
<touch a file>
8686
git add .
8787
git commit -m "Release v1.2.3"
@@ -90,36 +90,36 @@ git push
9090

9191
Go to the link printed by `git push` and fill out the Pull Request.
9292

93-
### 3) On github.com, verify the build action worked on your fork, then merge the PR to `develop`
93+
### 3) On github.com, verify the build action worked on your fork, then merge the PR to `v1_develop`
9494

9595
* Merging the PR will trigger the publish action on `upstream` (the main repo) and publish the Nuget package as a pre-release (e.g. `1.2.3-pre.1`).
9696

9797
### 4) Pull the merged `develop` from `upstream`
9898

9999
```powershell
100-
git checkout develop
101-
git pull upstream develop
100+
git checkout v1_develop
101+
git pull upstream v1_develop
102102
```
103103

104104
### 5) Merge `develop` into `main`
105105

106106
```powershell
107-
git checkout main
108-
git pull upstream main
109-
git merge develop
107+
git checkout v1_release
108+
git pull upstream v1_release
109+
git merge v1_develop
110110
```
111111

112112
Fix any merge errors.
113113

114-
At this point, to release a release candidate, push the `main` branch `upstream` without a new tag.
114+
At this point, to release a release candidate, push the `v1_release` branch `upstream` without a new tag.
115115

116116
```powershell
117-
git push upstream main
117+
git push upstream v1_release
118118
```
119119

120120
This will publish `1.2.3-rc.1` to Nuget.
121121

122-
### 6) Create a new annotated tag for the release on `main`
122+
### 6) Create a new annotated tag for the release on `v1_release`
123123

124124
```powershell
125125
git tag v1.2.3 -a -m "Release v1.2.3"
@@ -146,13 +146,13 @@ https://www.nuget.org/packages/Terminal.Gui
146146

147147
Generate release notes with the list of PRs since the last release.
148148

149-
### 11) Update the `develop` branch with the new version
149+
### 11) Update the `v1_develop` branch with the new version
150150

151151
```powershell
152-
git checkout develop
153-
git pull upstream develop
154-
git merge main
155-
git push upstream develop
152+
git checkout v1_develop
153+
git pull upstream v1_develop
154+
git merge v1_release
155+
git push upstream v1_develop
156156
```
157157

158158
## Nuget

0 commit comments

Comments
 (0)