Giving love (updates) #44
Conversation
Nosferican
commented
Aug 20, 2019
Nosferican
commented
- Use OSI standardized license text so it is machine detectable by GitHub/Licensee
- Update CI by including Windows (x64/x86) through Travis
- Update Codecov example (is codecov enabled for the repo?)
- Using current Pkg.jl format for test/docs stages
- Added example of using/import statements
- Added Weave for docs
- Use OSI standardized license text so it is machine detectable by GitHub/Licensee - Update CI by including Windows (x64/x86) through Travis - Update Codecov example - Using current Pkg.jl format for test/docs stages - Added example of using/import statements - Added Weave for docs
This now doesn't match what is generated by PkgTemplates and Pkg.generate, however. |
.gitignore
Outdated
| /docs/build/ | ||
| /docs/Manifest.toml | ||
| docs/build | ||
| docs/src |
There was a problem hiding this comment.
Okay, you are generating from weave into it? That is very non-standard and I don't think it should be in here.
There was a problem hiding this comment.
That's fine and fair. I think it is a cool practice that enhances Documenter.jl, but is fine if we keep it without it.
| julia: | ||
| - 1.0 |
There was a problem hiding this comment.
Errors the test/Project.toml / docs/Project.toml. Since the example is avoiding the experimental and will do the LTS flavor I can add it back.
|
|
||
| after_success: | ||
| - julia -e 'using Pkg; Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())'; | ||
| # - julia -e 'using Pkg; Pkg.add("Coverage"); using Coverage; Codecov.submit(Codecov.process_folder())'; |
There was a problem hiding this comment.
Is no longer needed. Missed adding the line codecov: true which is the updated way.
There was a problem hiding this comment.
I don't know if it's still the case, but for a while codecov: true/coveralls: true caused issues with how builds report failure (as errors instead of failures).
There was a problem hiding this comment.
Would be nice to check that since Coverage.jl has their documentation indicating that method currently.
docs/makedocs.yml
Outdated
| @@ -0,0 +1,6 @@ | |||
| site_name: Example.jl | |||
There was a problem hiding this comment.
Let's not add this, using the Documenter HTML is enough.
docs/make.jl
Outdated
|
|
||
| makedocs(modules = [Example], sitename = "Example.jl") | ||
| for file ∈ readdir(joinpath(dirname(pathof(Econometrics)), "..", "docs", "jmd")) |
There was a problem hiding this comment.
This feels like it would only confuse people. Like you need to do some weave stuff to run the documentation. Also weave is a bit of a heavy / complicated dependency.
| - 1.2 | ||
| - nightly | ||
|
|
||
| # # Uncomment the following lines to allow failures on nightly julia |
There was a problem hiding this comment.
Should packages usually test against nightly?
There was a problem hiding this comment.
Yes, though it would make sense to allow failures on nightlies by default. At any rate it's better to show how to do it.
| notifications: | ||
| email: false | ||
|
|
||
| #script: # the default script is equivalent to the following | ||
| # - if [[ -a .git/shallow ]]; then git fetch --unshallow; fi |
There was a problem hiding this comment.
This line can be removed but the subsequent line seems pretty useful.
test/Project.toml
Outdated
| @@ -0,0 +1,2 @@ | |||
| [deps] | |||
There was a problem hiding this comment.
I would prefer us to keep the target stuff in the Project because this way of doing it is explicitly marked experimental.
|
We should make the changes to PkgTemplates and Pkg.generate to use the OSI standard texts rather a custom text which is not machine detectable. |
Fixed a missing using
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
|
Can you split the PR into smaller pieces? That will help merging the less controversial changes soon. I'd like the question of the standard format to use for LICENSE.md to be settled here before switching other packages (as you propose in your PRs). |
