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

Just publish release branches #60

Merged
merged 1 commit into from
Dec 18, 2024
Merged

Just publish release branches #60

merged 1 commit into from
Dec 18, 2024

Conversation

Frostman
Copy link
Member

Fixes #59

@Frostman Frostman requested a review from a team as a code owner December 17, 2024 23:14
@Frostman Frostman force-pushed the 24.09-prep branch 2 times, most recently from 858c7d4 to 630d6c8 Compare December 17, 2024 23:19
Copy link

github-actions bot commented Dec 17, 2024

🚀 Deployed on https://preview-60--hedgehog-docs.netlify.app

@github-actions github-actions bot temporarily deployed to pull request December 17, 2024 23:20 Inactive
@github-actions github-actions bot temporarily deployed to pull request December 17, 2024 23:23 Inactive
@Frostman Frostman requested a review from qmonnet December 17, 2024 23:24
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

Please update the instructions in docs/contribute/docs.md before removing the Makefile

Not-related, minor question: Should we have a clean target in the justfile, to remove the generated files?

# TODO support publishing non-dev versions
if: github.event_name == 'push' && github.ref == 'refs/heads/master'
- name: Publish versioned docs
if: github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/heads/release/2'))
Copy link
Member

Choose a reason for hiding this comment

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

Could we seize this opportunity to rename the branch into main instead of master? 😇

Copy link
Member Author

Choose a reason for hiding this comment

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

we're using master in other repos (default in the org)

Copy link
Member

Choose a reason for hiding this comment

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

Time to update, then! Dataplane uses main 🙂

Copy link
Member

Choose a reason for hiding this comment

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

Docs are one of the most user-facing repos. For those that are not exposed as well, it's maybe less “important”.

Copy link
Member Author

Choose a reason for hiding this comment

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

It would've been better if it did stick to default so we don't need to switch any :) But I hear you, and we can have that discussion separately. I honestly don't see any reason to bother with it at that stage - in my experience a significant amount (just don't want to say "majority") of OSS projects live completely fine with the master branch.

Copy link
Member

Choose a reason for hiding this comment

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

They do, they're fine with master indeed. I don't see it as a major drawback for the project.

I see changing to main as a commitment, though. I do believe that “master” and “slave” have a strong meaning, and should probably never have been used in tech in the first place. But regardless of what I think, there are some people, maybe a small number, to whom the terminology “master”/“slave” brings painful associations, and to whom it matters. They might contribute to the project nonetheless, but not feel as comfortable doing so as they could. By naming our branch differently we acknowledge that this terminology can hurt, and we do our part to keep these words out of the field. More generally, we also indicate that we care about creating an inclusive community. Or at least, we take one step closer to it.

Justfile Show resolved Hide resolved
Justfile Outdated Show resolved Hide resolved
Justfile Outdated Show resolved Hide resolved
Makefile Show resolved Hide resolved
Makefile Show resolved Hide resolved
@qmonnet
Copy link
Member

qmonnet commented Dec 18, 2024

I meant to add, “apart from the nits, looks good overall 👍” 😇 The main thing to address is the docs/contribute/docs.md to update, the rest is just minor suggestions.

@Frostman Frostman requested a review from a team as a code owner December 18, 2024 16:22
@github-actions github-actions bot temporarily deployed to pull request December 18, 2024 16:22 Inactive
@Frostman
Copy link
Member Author

Frostman commented Dec 18, 2024

@qmonnet thank you very much for taking a look! I've tested as much as possible locally so 🤞

@github-actions github-actions bot temporarily deployed to pull request December 18, 2024 16:30 Inactive
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

I'll keep proposing to rename the main branch, but this is a debate that we don't need to hold as part of this PR.

The rest looks all good, even though I've not tested locally. Thanks!

@Frostman Frostman merged commit d1ea0af into master Dec 18, 2024
2 checks passed
@Frostman Frostman deleted the 24.09-prep branch December 18, 2024 17:19
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.

Autopublish for release branches
2 participants