Skip to content

Update the RELEASING.md file for the newest steps due to GitHub Actions #6730

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dlvenable merged 1 commit into from
Apr 6, 2026
Merged

Update the RELEASING.md file for the newest steps due to GitHub Actions #6730

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 16 additions & 23 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,43 +40,36 @@ Steps:
2. Select `New label`
3. Name the branch `backport {major}.minor`. For example, `backport 2.6`

### Update versions

The OpenSearch Data Prepper version is defined in the [`gradle.properties`](https://github.com/opensearch-project/data-prepper/blob/main/gradle.properties) file.
We must update this whenever we create a new release.
We will need two PRs to update it.

#### Update on release branch

For the current release branch, update the version to the new version.
You may either need to update by removing the `-SNAPSHOT` or by updating the patch version.

For example, when we released `2.6.2`, the property was set as `version=2.6.2`.
You can see the [exact commit here](https://github.com/opensearch-project/data-prepper/blob/2.6.2/gradle.properties#L8).

Create a PR that targets the release branch with the change.
Do not create a PR to `main` for this.

#### Update on the main branch

The OpenSearch Data Prepper version is defined in the [`gradle.properties`](https://github.com/opensearch-project/data-prepper/blob/main/gradle.properties) file.
After creating a new branch, we must also bump the version for the `main` branch to the next version.

If you have just created a release branch, you should also create a PR on the `main` branch to bump the version.

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`.
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`.

### Update the THIRD-PARTY file
### Prepare release branch

We should update the `THIRD-PARTY` file for every release.
OpenSearch Data Prepper has a GitHub action that will generate this and create a PR with the updated file.
For any release, you must prepare the release branch.
This is applicable for new major/minor releases and patch releases.

Steps:
* Go the [Third Party Generate action](https://github.com/opensearch-project/data-prepper/actions/workflows/third-party-generate.yml)
* Go the [Prepare Release Branch](https://github.com/opensearch-project/data-prepper/actions/workflows/release-prepare-branch.yml) action.
* Select `Run workflow`
* Choose the branch you are releasing. e.g. `2.6`
* Choose the branch you are releasing. e.g. `2.15`
* Press `Run workflow`
* Wait for a new PR to be created
* Spot check the PR, approve and merge


This action will create a PR that updates files as necessary

* `gradle.properties`
* `THIRD-PARTY`

Approve this and merge it before proceeding with the release.

### Prepare release notes

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).
Expand Down
Loading