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

Add note to README to update workflow triggers #128

Merged
merged 4 commits into from Jun 6, 2021
Merged

Add note to README to update workflow triggers #128

merged 4 commits into from Jun 6, 2021

Conversation

vsoch
Copy link
Contributor

@vsoch vsoch commented Jun 5, 2021

This was an oversight on my part that I would suspect others might run into - I used the template and pushed to a main branch, and totally missed the fact that none of the workflows were running. When it was time to properly add tests I realized that the files were there, and I simply needed to update the branch from master to main. So that others don't run into this issue, I am suggesting adding a line in the README to alert the reader to do the change.

This was an oversight on my part that I would suspect others might run into - I used the template and pushed to a main branch, and totally missed the fact that none of the workflows were running. When it was time to properly add tests I realized that the files were there, and I simply needed to update the branch from master to main. So that others don't run into this issue, I am suggesting adding a line in the README to alert the reader to do the change.
@TheLartians
Copy link
Owner

TheLartians commented Jun 6, 2021

Good point, I started working on this template when the default branch name was still master and can see how it may be confusing now. Thanks for creating the PR!

As an alternative to the workflow note, how would you feel about simply adding triggers for both main and master to the workflows? This would make it easier to get started at the cost of an obsolete branch name per workflow.

Signed-off-by: vsoch <vsoch@users.noreply.github.com>
@vsoch
Copy link
Contributor Author

vsoch commented Jun 6, 2021

Yes that's a great idea! Done.

Comment on lines 7 to 8
- main

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small formatting nitpick, but could you remove the extra new line from here and the ubuntu and windows workflows, to make them consistent with the others?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All set.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, the newline is still in the style.yml workflow commented above, as far as I can tell.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's embarrassing! My editor didn't save the file (err, I didn't seem to hit save 😆) - should be good now :)

vsoch added 2 commits June 6, 2021 13:06
Signed-off-by: vsoch <vsoch@users.noreply.github.com>
Signed-off-by: vsoch <vsoch@users.noreply.github.com>
Copy link
Owner

@TheLartians TheLartians left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks for the changes!

@TheLartians TheLartians enabled auto-merge (squash) June 6, 2021 20:35
@TheLartians TheLartians merged commit b347492 into TheLartians:master Jun 6, 2021
@vsoch
Copy link
Contributor Author

vsoch commented Jun 6, 2021

Thank you for the template! I'm a bit green to C++ and I was able to get started with my project so quickly thanks to this.

@vsoch vsoch deleted the patch-1 branch June 6, 2021 20:39
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