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

Use 'main' instead of 'master' for examples #65

Merged
merged 1 commit into from Nov 30, 2021
Merged

Conversation

JLHasson
Copy link
Contributor

main is now the default branch name: https://github.com/github/renaming#new-repositories-use-main-as-the-default-branch-name

Update the examples in the docs to reflect this

@creyD
Copy link
Owner

creyD commented Oct 31, 2021

Hi, sorry for the delay in response. You actually make a good point, as the default experience has been changed and this could be confusing for extremely new people. However I also worry about users with existing repos, which would potentially confused by this. Maybe it would be better to replace the examples with placeholder tags like YOUR_BRANCHNAME_HERE or something like that. What do you think?

@JLHasson
Copy link
Contributor Author

JLHasson commented Oct 31, 2021

No need to apologize, thanks for taking a look 😄

I think either can work - personally I think I would side with following the convention set by GitHub. In my opinion it's pretty obvious that branches is something you will need to configure if you want the command to run. I'll leave it up to you, if we were to use a template string I would probably suggest using a bash-style variable like

  push:
    branches:
    - ${BRANCH_NAME}

but I guess that could also be confusing since some people may think the variable will get filled by Github Actions which I don't believe is true.

@creyD creyD changed the base branch from master to dev November 30, 2021 16:02
@creyD creyD merged commit aecd857 into creyD:dev Nov 30, 2021
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.

None yet

2 participants