Skip to content
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

Jump to bottom

Fix docs check in release process (fixes #1375) #1377

Merged
merged 1 commit into from
Jul 29, 2024
Merged

Fix docs check in release process (fixes #1375) #1377

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
27 changes: 19 additions & 8 deletions docs/content/en/contribute/releasing/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,11 @@ description: "How to perform releases of k8ssandra-operator"

## Prerequisites

[yq](https://github.com/mikefarah/yq) and [Hugo](https://gohugo.io/documentation/) installed.
[yq](https://github.com/mikefarah/yq) installed.

With MacOS / Homebrew:
```shell
brew install yq
brew install hugo
```

## Major / Minor Release
Expand Down Expand Up @@ -74,7 +73,9 @@ git commit -m"Update changelog for v${RELEASED_MAJOR_MINOR?}.0"

```shell
cd docs
hugo mod clean

npm install
npm run clean
npm run build:production

cd ..
Expand Down Expand Up @@ -118,10 +119,14 @@ The diff should look like this:
version: 0.29.0
```

Commit and push the changes:
Commit:
```shell
git add config/deployments/default/kustomization.yaml charts/k8ssandra-operator/Chart.yaml
git commit -m"Release v${RELEASED_MAJOR_MINOR?}.0"
```

Push the changes:
```shell
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Unrelated, but I like to double-check my commits before I push.
Separate code blocks make it easier to copy-paste the commands.

git push ${GIT_REMOTE?} release/${RELEASED_MAJOR_MINOR?}
```

Expand Down Expand Up @@ -206,7 +211,7 @@ git cherry-pick -n <your commit SHA-1s...>
Amend the merge commit with your cherry-picks:
```shell
git add .
git commit --amend
git commit --amend --no-edit
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick: Not my cup of tea, I like to have the ability to edit the commit message when amending since it might be out of date. Thus, --no-edit feels odd.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a merge commit though, I don't think we've ever had the need to reword it. Example

I'm going to leave it as is since it's the most common case, it's easy enough to modify the command or do another commit --amend if you want to change the message.

```

Update the version in the release chart:
Expand Down Expand Up @@ -331,7 +336,9 @@ git commit -m"Update changelog for v${RELEASED_FULL?}"

```shell
cd docs
hugo mod clean

npm install
npm run clean
npm run build:production

cd ..
Expand Down Expand Up @@ -375,10 +382,14 @@ The diff should look like this:
version: 0.29.0
```

Commit and push the changes:
Commit:
```shell
git add config/deployments/default/kustomization.yaml charts/k8ssandra-operator/Chart.yaml
git commit -m"Release v${RELEASED_FULL?}"
```

Push the changes:
```shell
git push ${GIT_REMOTE?} release/${RELEASED_MAJOR_MINOR?}
```

Expand Down Expand Up @@ -464,7 +475,7 @@ git cherry-pick -n <your commit SHA-1s...>
Amend the merge commit with your cherry-picks:
```shell
git add .
git commit --amend
git commit --amend --no-edit
```

Push all the changes:
Expand Down