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.

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

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

Merged
merged 1 commit into from
Jul 29, 2024

Conversation

olim7t
Copy link
Contributor

@olim7t olim7t commented Jul 25, 2024

What this PR does:
Only use npm commands to check that the documentation builds (there's no need to install Hugo separately).

Our Hugo version is outdated, but there's no pressing need to upgrade at the moment.

Which issue(s) this PR fixes:
Fixes #1375

Checklist

  • Changes manually tested
  • Automated Tests added/updated
  • Documentation added/updated
  • CHANGELOG.md updated (not required for documentation PRs)
  • CLA Signed: DataStax CLA

@olim7t olim7t requested a review from a team as a code owner July 25, 2024 15:33
Copy link

sonarcloud bot commented Jul 25, 2024

```

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.

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

@olim7t olim7t merged commit 5d5cea3 into k8ssandra:main Jul 29, 2024
2 checks passed
@olim7t olim7t deleted the release-docs branch July 29, 2024 16:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix the docs build on MacOS
2 participants