Skip to content

Commit 671716e

Browse files
authored
Update RELEASE.md (#1)
doing cleanup
1 parent a43eaf7 commit 671716e

File tree

1 file changed

+1
-136
lines changed

1 file changed

+1
-136
lines changed

RELEASE.md

Lines changed: 1 addition & 136 deletions
Original file line numberDiff line numberDiff line change
@@ -5,140 +5,5 @@
55

66
## Process
77

8-
### 1. Pull Latest
9-
10-
On your development machine, pull the latest `dev` and `main` branches
11-
12-
```bash
13-
# Development Machine
14-
git switch dev
15-
git pull
16-
git switch main
17-
git pull
18-
```
19-
20-
### 2. Create Release Branch from `main`
21-
22-
On your development machine, create a release branch off of main
23-
24-
```bash
25-
# Development Machine
26-
git switch main
27-
git switch -c release/vX.Y.Z
28-
```
29-
30-
### 3. Merge `dev` to New Release Branch
31-
32-
Merge `dev` into the new release branch, handling any merge conflicts.
33-
34-
```bash
35-
# Development Machine
36-
git switch release/vX.Y.Z
37-
git merge dev
38-
```
39-
40-
Commit the fully-resolved merge with the default merge commit message.
41-
42-
### 4. Update the `CHANGELOG.md` File
43-
44-
Change the "Unreleased" section to the current version number, with the link to the
45-
release underneath (see all previous versions for examples).
46-
47-
```diff
48-
-## [Unreleased]
49-
+<!--## [Unreleased] -->
50-
+## [vX.Y.Z]
51-
+[vX.Y.Z Release Page]
52-
```
53-
54-
Be sure to add the associated links at the bottom of the file underneath the "Unreleased" reference:
55-
56-
```diff
57-
[Unreleased]: https://git.keithley.com/trebuchet/teaspoon/ki-comms/-/tree/dev
58-
+[vX.Y.Z]: https://git.keithley.com/trebuchet/teaspoon/web-help-documents/-/compare/v(X.Y.Z - 1)...vX.Y.Z?from_project_id=33
59-
+[vX.Y.Z Release Page]: https://git.keithley.com/trebuchet/teaspoon/web-help-documents/-/releases/vX.Y.Z
60-
```
61-
(Where `v(X.Y.Z - 1)` is the previous released version)
62-
63-
Be sure to check the merge requests for this past version to make sure everything was added to the changelog. Add anything that was missed (with JIRA issue number).
64-
65-
You can do that with a query like the one at this link: https://git.keithley.com/trebuchet/teaspoon/web-help-documents/-/merge_requests?scope=all&state=merged&deployed_after=03%2F29%2F2023&deployed_before=04%2F14%2F2023
66-
67-
### 5. Update the Version Information
68-
69-
Update the `package.json` version number:
70-
71-
> **package.json**
72-
> ```diff
73-
> - "version": "0.6.0",
74-
> + "version": "X.Y.Z",
75-
> ```
76-
77-
Commit the CHANGELOG.md and package version changes in a single commit with something similar to:
78-
79-
```
80-
Update Version Numbers
81-
```
82-
83-
### 6. Create Merge Requests
84-
85-
Push the release branch to GitLab:
86-
87-
```bash
88-
git push -u origin release/vX.Y.Z
89-
```
90-
91-
#### Create a merge request from the `release/vX.Y.Z` branch into `main` with the following details:
92-
93-
> * From `release/vX.Y.Z` into `main` (you will need to "Change branches" for this, as it defaults to `dev`)
94-
> * **Title:** Release vX.Y.Z
95-
> * **Description:** Delete template text and insert "Internal vX.Y.Z Release"
96-
> * **Assignee:** Yourself
97-
> * **Reviewer:** Pick someone
98-
> * **Milestone:** Select the appropriate milestone (vX.Y.Z)
99-
> * **Labels:** Add "Release"
100-
> * **Merge Options**
101-
> - Select **ONLY** "Squash commits when merge request is accepted"
102-
103-
104-
#### Create a merge request from the `release/vX.Y.Z` branch into `dev` with the following details:
105-
106-
> * From `release/vX.Y.Z` into `dev`
107-
> * **Title:** Release vX.Y.Z into dev
108-
> * **Description:** Delete template text and insert "Internal vX.Y.Z Release into dev"
109-
> * **Assignee:** Yourself
110-
> * **Reviewer:** Pick someone
111-
> * **Milestone:** Select the appropriate milestone (vX.Y.Z)
112-
> * **Labels:** Add "Release: Dev"
113-
> * **Merge Options**
114-
> - Select **ONLY** "Delete source branch when merge request is accepted"
115-
116-
### 7. Complete Merge into `main` _**FIRST**_
117-
118-
Complete the merge into the `main` branch.
119-
120-
121-
### 8. Tag `main` with `vX.Y.Z`
122-
123-
Create a [tag](https://git.keithley.com/trebuchet/teaspoon/web-help-documents/-/tags) for the new version.
124-
> * **Tag Name:** `vX.Y.Z`
125-
> * **Create from:** `main` (This is NOT default, make sure to change it)
126-
> * **Message:** Internal vX.Y.Z Release
127-
128-
Wait for the automatically started [pipeline](https://git.keithley.com/trebuchet/teaspoon/web-help-documents/-/pipelines) to complete.
129-
130-
### 9. Verify Release
131-
132-
Check the following to ensure that the release completed successfully:
133-
134-
* [Releases page](https://git.keithley.com/trebuchet/teaspoon/web-help-documents/-/releases) should show `vX.Y.Z`
135-
* [Package registry](https://git.keithley.com/trebuchet/teaspoon/web-help-documents/-/packages) should show the new version
136-
137-
### 10. Update Release Notes
138-
139-
The release notes will have "TBD" in the "Added Features" and "Known Issues" sections. Copy all the sections from the CHANGELOG.md file for the current version release and past them into the "Added Features" section. List any known issues in the "Known Issues" section.
140-
141-
### 11. Complete Merge into `dev`
142-
143-
This will delete the `release/vX.Y.Z` branch.
8+
TODO
1449

0 commit comments

Comments
 (0)