-
Notifications
You must be signed in to change notification settings - Fork 7
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
Conversation
858c7d4
to
630d6c8
Compare
🚀 Deployed on https://preview-60--hedgehog-docs.netlify.app |
There was a problem hiding this 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')) |
There was a problem hiding this comment.
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
? 😇
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
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
🙂
There was a problem hiding this comment.
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”.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
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. |
@qmonnet thank you very much for taking a look! I've tested as much as possible locally so 🤞 |
There was a problem hiding this 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!
Fixes #59