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

[doc] Branch reference syntax is imperfect #502

Open
webknjaz opened this issue Sep 5, 2022 · 1 comment
Open

[doc] Branch reference syntax is imperfect #502

webknjaz opened this issue Sep 5, 2022 · 1 comment
Labels
bug Something isn't working docs Documentation

Comments

@webknjaz
Copy link

webknjaz commented Sep 5, 2022

The docs show-case examples with @some-branch in remote URLs followed by a file path with slashes. But what if a branch name itself has slashes in it?

It is common to have branches like features/issue-number/branch-description or release/v1.0. Is it possible to still reference them w/o resorting to using commit SHAs? Would urlescaping of these slashes work?

@webknjaz webknjaz added the bug Something isn't working label Sep 5, 2022
@andreoliwa
Copy link
Owner

Is it possible to still reference them w/o resorting to using commit SHAs? Would urlescaping of these slashes work?

To be honest, I don't think this will work.
I didn't cover such possibilities because I was thinking mostly of common branch names like master, develop and main.
That's what happens when you work alone without code review. 😅

I'll try this when I have time, and see what breaks (or hopefully works).

@andreoliwa andreoliwa moved this to Upvoted / Requests in Nitpick Roadmap Sep 19, 2022
@andreoliwa andreoliwa added the docs Documentation label Oct 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working docs Documentation
Projects
Status: Upvoted / Requests
Development

No branches or pull requests

2 participants