search

monome-community / norns-community

website listing norns community catalog and documentation
https://norns.community
6 stars 2 forks source link

Don't hard code Git branch name #10

Closed ghost closed 1 year ago

ghost commented 1 year ago

The page for rebound is missing the contents of the project's readme file.

I did some debugging and found that 02-build.py hardcodes the branch name main. The rebound project has a master branch, but not a main branch (the repo was created before Github renamed the default branch to main).

Fix by using the remote head instead of a hard coded branch name. In 02-build.py, change:

github_raw_url_template = 'https://raw.githubusercontent.com/GITHUB_AUTHOR/GITHUB_PROJECT/main'

to: 

github_raw_url_template = 'https://raw.githubusercontent.com/GITHUB_AUTHOR/GITHUB_PROJECT/HEAD'
tyleretters commented 1 year ago

thank you for the issue and suggestion, @mylo88!

would you be opposed to renaming the branch?

our decision to use main is part of the broader tech-initiative to favor more neutral language such as denylist and allowlist.

relatedly (and i don't want to speak for @tehn or @dndrks or others so maybe they can chime in) but i gather this may one day be this a hard requirement for scripts.

ghost commented 1 year ago

I am not the owner of the rebound project.

More than 30% of the projects listed in community.norns do not use main as the default branch name.

It is common practice to use remote HEAD as the default branch. That's what git clone uses.

The broader initiatives are generally about providing tools or making changes so developers can remove or avoid offensive terms. Requiring a developer to change a term in their project is above and beyond most of these initiatives.

tyleretters commented 1 year ago

hey! thanks for surfacing this info. we discussed it and definitely did not realize 30% of the projects do not use main. also, please accept my apology for assuming this was your script.

this has been addressed in #11