search

TheLartians / ModernCppStarter

🚀 Kick-start your C++! A template for modern C++ projects using CMake, CI, code coverage, clang-format, reproducible dependency management and much more.
https://thelartians.github.io/ModernCppStarter
The Unlicense
4.45k stars 388 forks source link

Add note to README to update workflow triggers #128

Closed vsoch closed 3 years ago

vsoch commented 3 years ago

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 commented 3 years ago

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.

vsoch commented 3 years ago

Yes that's a great idea! Done.

vsoch commented 3 years ago

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.