From b58fcc854a9a4061320a9d7e3f129b9533126246 Mon Sep 17 00:00:00 2001 From: Thomas Gran Date: Thu, 2 Jan 2025 17:30:04 +0100 Subject: [PATCH] refactor: Reformat MavenUpdatePomVersion --- script/RELEASE_README.md | 12 +++++++----- .../utils/ci/MavenUpdatePomVersion.java | 1 - 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/script/RELEASE_README.md b/script/RELEASE_README.md index d94ea15e3d3..6353441b97a 100644 --- a/script/RELEASE_README.md +++ b/script/RELEASE_README.md @@ -12,13 +12,14 @@ The scripts here can be used to release a fork of OTP. Run # script/release ``` -Process overview: +### Process overview - You specify the _base branch_, normally `dev-2.x` in git repo [`opentripplanner/OpenTripPlanner`](https://github.com/opentripplanner/OpenTripPlanner). - The release branch is rebased on top of the base branch. **Nothing is kept from previous releases.** + The release branch is rebased on top of the base branch(fork). + **Nothing is kept from previous releases.** - The 2 steps allow you to merge in "work in progress" before the final release is made. - If something goes wrong, like a conflicting merge, you may fix the problem and resume the release - by running the `prepare_release` script again. + by running the `prepare_release` script again. Use the exact same arguments. - Each release is given a unique version number specific to your fork, like `v2.7.0-MY_ORG-1`. - The release is tagged with the version in the Git repository. - The old release is then merged with an _empty merge_, this is done to create a continuous line @@ -38,7 +39,7 @@ commit would be challenging since commit (D) was already in the release branch a Also note that the CI configuration is changed (c2) and this change needs to be included in the new release (v3). -> **Note!** OTP ignore config it does not understand. This allows us to roll out config for new +> **Note!** OTP ignore config it does not understand it. This allows us to roll out config for new > features BEFORE we roll out the new version of OTP. We can then verify that the old version of > OTP works with the new config. Config is dependent on both the environment OTP run in and OTP. > So, the config has its own life-cycle, independent of the OTP software. @@ -85,7 +86,7 @@ GIT_REMOTE_RELEASE_ORG="" Substitute `` and `` with the correct values. Commit and push this file to the `ext_config` branch in your organizations fork of OTP. Note! The must match the -GitHub organization. +GitHub organization name in your local Git clone. Use `git remote -v` to list all remote repos. ## Pending Pull Requests @@ -98,6 +99,7 @@ at Entur before the PR is accepted and merged in the upstream repo. We combine t and sometimes the OTPFeature toggle to turn on new features in over test environment. When a new feature is tested ok, then we enable it in the production environment. + ## How To Make A Release Find the target branch/commit or use the branch `otp/dev-2.x`. If you use a specific branch/commit, diff --git a/utils/src/main/java/org/opentripplanner/utils/ci/MavenUpdatePomVersion.java b/utils/src/main/java/org/opentripplanner/utils/ci/MavenUpdatePomVersion.java index 0e06075c9ea..7b1c3a8e431 100644 --- a/utils/src/main/java/org/opentripplanner/utils/ci/MavenUpdatePomVersion.java +++ b/utils/src/main/java/org/opentripplanner/utils/ci/MavenUpdatePomVersion.java @@ -13,7 +13,6 @@ import java.util.regex.Pattern; import java.util.stream.Stream; - /** * This class is used by the release scripts; Hence not part of the main OTP. * TODO: Convert this to a script.