Build better listing of branch naming expectations
The following discussion from !118100 (merged) should be addressed:
-
@aqualls started a discussion: (+1 comment) My hunch about digging deeper was correct:
- We do talk about branch name expectations in multiple places
- We SHOULD talk about branch naming requirements in https://docs.gitlab.com/ee/user/project/repository/branches/ but do not. We need a SSOT that other pages can point back to.
I can fix both problems, but I should seek technical review first to determine what we SHOULD say.
-
Are the new, looser restrictions described in this MR correct? Ensure ref passed to SearchFiles is ASCII-8BIT ... (!114154 - merged) will be useful here. (I'm pretty sure what was originally proposed in this MR is incomplete, but let's start off by at least fixing the existing error.) -
Are the stricter requirements in https://docs.gitlab.com/ee/development/go_guide/index.html#naming-branches a problem? Do we need to state them in the user-facing branch-naming section? (Unsure. Being safe.) -
(Optional, but a nice style point.) Could you please give me an update for the last regex in https://docs.gitlab.com/ee/user/project/repository/push_rules.html#validate-branch-names so it does reasonable checks for valid branch names in GitLab? -
https://docs.gitlab.com/ee/user/project/repository/push_rules.html#validate-branch-names also says Names with 40 hexadecimal characters, similar to Git commit hashes, are prohibited.
Is this still true? If yes, I should add it to the branch naming requirements. -
https://docs.gitlab.com/ee/administration/packages/container_registry.html#docker-connection-error contains mentions of potentially problematic branch names. Is this info still valid? Should we garden this information back into the branch naming section?
-
Update https://docs.gitlab.com/ee/user/project/repository/branches/index.html to explain in the "branch naming" section what characters are, and are not, allowed. -
https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html should be updated to point back to this section. -
https://docs.gitlab.com/ee/gitlab-basics/start-using-git.html#create-a-branch should be updated to point back to this section.
-
-
Update other pages depending on what I learn from the technical reviewer.
Edited by Amy Qualls