Reduce number of CI jobs

[rikhuijzer]

At JuliaLang/Example.jl#55, Fredrik Ekre mentions that PkgTemplates advises quite a lot of jobs by default. I agree and would also argue that most repositories only run a few Linux jobs. In this PR, I propose to comment out some of the jobs, so that users can decide for themselves. This is just a suggestion; let me know if I should update the Travis and Appveyor and tests accordingly.

The change of filename is just because ci.yml looks a bit weird next to CompatHelper.yml and TagBot.yml, see, for example, https://github.com/rikhuijzer/Gadfly.jl/tree/master/.github/workflows.

[christopher-dG]

This PR doesn't do what you think it does, you're just changing PkgTemplates' CI configs, not the ones it generates.

To do the thing you want to do, you just need to change the default value of osx and windows to false in the GitHubActions struct definition.

Personally, I'm on board with this, I generally only test Linux myself unless my package does a lot of FS stuff or other platform-dependent stuff. @nickrobinson251 could I get your take on behalf of Invenia?

[rikhuijzer]

Okay, thanks for the pointers. 😄 I'll now wait for the reply from Invenia('s representative)

[codecov]

Codecov Report

Merging #252 (fe6c70d) into master (829d241) will increase coverage by 0.35%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #252      +/-   ##
==========================================
+ Coverage   81.86%   82.21%   +0.35%     
==========================================
  Files          19       19              
  Lines         612      613       +1     
==========================================
+ Hits          501      504       +3     
+ Misses        111      109       -2     

Impacted Files	Coverage Δ
src/plugins/ci.jl	88.00% <ø> (ø)
src/template.jl	90.55% <0.00%> (+0.78%)	⬆️
src/plugin.jl	84.12% <0.00%> (+1.86%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 829d241...fe6c70d. Read the comment docs.

[nickrobinson251]

Yeah, i think templates defaulting to running on Linux only is fine!

i.e.

        linux=true,
        osx=false,
        windows=false,

Probably want GitHubActions and TravisCI to be consistent on this?

[christopher-dG]

Ok, looking good. The last step is to update the tests. You can move the existing ci.yml reference files to their new CI.yml paths:

test/fixtures/AllPlugins/.github/workflows/ci.yml
test/fixtures/WackyOptions/.github/workflows/ci.yml
test/fixtures/DocumenterGitHubActions/.github/workflows/ci.yml

And then run the unit tests from the Pkg REPL mode, you should be prompted to accept the changes to those files (although some people have reported that this bit doesn't quite work).

[rikhuijzer]

Clear explanation. Thank you.

I've ran the tests and got prompted to change two files (pressed y twice). Then, I ran the tests again and everything passed locally.

[christopher-dG]

Something odd appears to have happened with WackyOptions' GHA config, there is a file both at .github/CI.yml and at .github/workflows/CI.yml (the latter is the correct path).

[rikhuijzer]

Something odd appears to have happened with WackyOptions' GHA config, there is a file both at .github/CI.yml and at .github/workflows/CI.yml (the latter is the correct path).

Probably me making a mistake when using mv.