From 840c435e4a13292f38b9f802011c4e5d2dba9b13 Mon Sep 17 00:00:00 2001 From: Adam Lewis <23342526+Adam-D-Lewis@users.noreply.github.com> Date: Mon, 30 Sep 2024 09:36:31 -0500 Subject: [PATCH 1/3] support develop to main rename on nebari repo --- docs/community/maintainers/release-process.md | 18 +++++------------- .../maintainers/reviewer-guidelines.md | 2 +- 2 files changed, 6 insertions(+), 14 deletions(-) diff --git a/docs/community/maintainers/release-process.md b/docs/community/maintainers/release-process.md index 0a312d799..26463dd02 100644 --- a/docs/community/maintainers/release-process.md +++ b/docs/community/maintainers/release-process.md @@ -47,24 +47,16 @@ For example, the first Nebari CalVer release was `2022.10.1`. If a hotfix releas We use the following guidelines to manage `git` branches by assigning certain roles to particular branches. -- [`develop`](https://github.com/nebari-dev/nebari/tree/develop) - Represents the active development branch and is the _default_ branch on the GitHub repository. +- [`main`](https://github.com/nebari-dev/nebari/tree/main) - Represents the active development branch and is the _default_ branch on the GitHub repository. -- [`main`](https://github.com/nebari-dev/nebari/tree/main) - Represents a production-ready state of the code-base, with an appropriate tag to match the most recent release. -- `release/YYYY-MM-releaseNumber` - Represents the branch for the upcoming release and only briefly exist while actively preparing for the release. +## Release Tags -### Process - -Although this process is captured in the [release checklist template](https://github.com/nebari-dev/nebari/issues/new?assignees=&labels=type%3A+release+%F0%9F%8F%B7&template=release-checklist.md&title=%5BRELEASE%5D+%3Cversion%3E), it's worth making clear how branches are managed. +- `YYYY-MM-releaseNumber` - Represents the tag for a particular release. -- Active development occurs against the `develop` branch. -- When it's time for a release, the Release Captain will create the release branch `release/YYYY-MM-releaseNumber` and prepare the branch for the release. At times, this might mean cherry-picking commits that are needed for this release and at other times, this might mean merging `develop` into this release branch. -- As soon as this release branch is ready, the Release Captain can open a pull request against `main`. From here, all of the changes that are included in the release should be visible in the "Files changed" section of the pull request. -- Once CI passes, all manual tests are successful and the team is happy with the changes, the Release Captain can complete the release checklist and cut the release. - -#### Hotfixes +### Process -In the event that a patch or hotfix release is needed, release process is the same as outlined above. The only difference is that the commits that are merged into the hotfix release branch will need to be cherry-picked from the `develop` branch. +The release process is captured in the [release checklist template](https://github.com/nebari-dev/nebari/issues/new?assignees=&labels=type%3A+release+%F0%9F%8F%B7&template=release-checklist.md&title=%5BRELEASE%5D+%3Cversion%3E). ## Related packages diff --git a/docs/community/maintainers/reviewer-guidelines.md b/docs/community/maintainers/reviewer-guidelines.md index c218ab687..12347c27d 100644 --- a/docs/community/maintainers/reviewer-guidelines.md +++ b/docs/community/maintainers/reviewer-guidelines.md @@ -62,7 +62,7 @@ Only maintainers can merge pull requests. Please follow these guidelines: - If the contribution is made to the `nebari-dev/nebari` repository, then you'll need to trigger the Kubernetes tests by commenting `/bot run tests` on the PR. - If the contribution is made to the `nebari-dev/nebari-docs` repository, then make sure to check the Netlify build and preview. -- In case of merge conflicts, ask the PR submitter to rebase on `develop`. +- In case of merge conflicts, ask the PR submitter to rebase on `main`. - Squashing commits or cleaning up commit messages of a PR that you consider too messy is OK. Remember to retain the original author’s name when doing this. - When you want to reject a PR: if it’s very straightforward, you can close it and explain why. If it’s not, From 327dc41aaa8d4fb7a1111a0df88baa885996bf93 Mon Sep 17 00:00:00 2001 From: Adam Lewis <23342526+Adam-D-Lewis@users.noreply.github.com> Date: Mon, 30 Sep 2024 10:28:03 -0500 Subject: [PATCH 2/3] update formatting --- docs/community/maintainers/release-process.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/community/maintainers/release-process.md b/docs/community/maintainers/release-process.md index 26463dd02..08c84ad41 100644 --- a/docs/community/maintainers/release-process.md +++ b/docs/community/maintainers/release-process.md @@ -49,7 +49,6 @@ We use the following guidelines to manage `git` branches by assigning certain ro - [`main`](https://github.com/nebari-dev/nebari/tree/main) - Represents the active development branch and is the _default_ branch on the GitHub repository. - ## Release Tags - `YYYY-MM-releaseNumber` - Represents the tag for a particular release. From 67fc4337b0c4bf09353716be85e627e26811f9a1 Mon Sep 17 00:00:00 2001 From: Adam Lewis <23342526+Adam-D-Lewis@users.noreply.github.com> Date: Tue, 12 Nov 2024 09:47:19 -0600 Subject: [PATCH 3/3] update link --- docs/community/maintainers/release-process.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/community/maintainers/release-process.md b/docs/community/maintainers/release-process.md index 08c84ad41..c6d9b5fbd 100644 --- a/docs/community/maintainers/release-process.md +++ b/docs/community/maintainers/release-process.md @@ -55,7 +55,7 @@ We use the following guidelines to manage `git` branches by assigning certain ro ### Process -The release process is captured in the [release checklist template](https://github.com/nebari-dev/nebari/issues/new?assignees=&labels=type%3A+release+%F0%9F%8F%B7&template=release-checklist.md&title=%5BRELEASE%5D+%3Cversion%3E). +The release process is captured in the [release checklist template](https://github.com/nebari-dev/nebari/blob/main/.github/ISSUE_TEMPLATE/release-checklist.md). In the event that a patch or hotfix release is needed, release process is the same as outlined above. ## Related packages