You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: RELEASING.md
+16-23Lines changed: 16 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,43 +40,36 @@ Steps:
40
40
2. Select `New label`
41
41
3. Name the branch `backport {major}.minor`. For example, `backport 2.6`
42
42
43
-
### Update versions
44
-
45
-
The OpenSearch Data Prepper version is defined in the [`gradle.properties`](https://github.com/opensearch-project/data-prepper/blob/main/gradle.properties) file.
46
-
We must update this whenever we create a new release.
47
-
We will need two PRs to update it.
48
-
49
-
#### Update on release branch
50
-
51
-
For the current release branch, update the version to the new version.
52
-
You may either need to update by removing the `-SNAPSHOT` or by updating the patch version.
53
-
54
-
For example, when we released `2.6.2`, the property was set as `version=2.6.2`.
55
-
You can see the [exact commit here](https://github.com/opensearch-project/data-prepper/blob/2.6.2/gradle.properties#L8).
56
-
57
-
Create a PR that targets the release branch with the change.
58
-
Do not create a PR to `main` for this.
59
-
60
43
#### Update on the main branch
61
44
45
+
The OpenSearch Data Prepper version is defined in the [`gradle.properties`](https://github.com/opensearch-project/data-prepper/blob/main/gradle.properties) file.
46
+
After creating a new branch, we must also bump the version for the `main` branch to the next version.
47
+
62
48
If you have just created a release branch, you should also create a PR on the `main` branch to bump the version.
63
49
64
-
For example, if you have started the `2.7` branch, you will need to update the `main` branch from `2.6.0-SNAPSHOT` to `2.7.0-SNAPSHOT`.
50
+
For example, if you have started the `2.7` branch, you will need to update the `main` branch from `2.7.0-SNAPSHOT` to `2.8.0-SNAPSHOT`.
65
51
66
-
### Update the THIRD-PARTY file
52
+
### Prepare release branch
67
53
68
-
We should update the `THIRD-PARTY` file for every release.
69
-
OpenSearch Data Prepper has a GitHub action that will generate this and create a PR with the updated file.
54
+
For any release, you must prepare the release branch.
55
+
This is applicable for new major/minor releases and patch releases.
70
56
71
57
Steps:
72
-
* Go the [Third Party Generate action](https://github.com/opensearch-project/data-prepper/actions/workflows/third-party-generate.yml)
58
+
* Go the [Prepare Release Branch](https://github.com/opensearch-project/data-prepper/actions/workflows/release-prepare-branch.yml) action.
73
59
* Select `Run workflow`
74
-
* Choose the branch you are releasing. e.g. `2.6`
60
+
* Choose the branch you are releasing. e.g. `2.15`
75
61
* Press `Run workflow`
76
62
* Wait for a new PR to be created
77
63
* Spot check the PR, approve and merge
78
64
79
65
66
+
This action will create a PR that updates files as necessary
67
+
68
+
*`gradle.properties`
69
+
*`THIRD-PARTY`
70
+
71
+
Approve this and merge it before proceeding with the release.
72
+
80
73
### Prepare release notes
81
74
82
75
Prepare release notes and check them into the `main` branch in the [`release-notes` directory](https://github.com/opensearch-project/data-prepper/tree/main/release/release-notes).
0 commit comments