Skip to content

update CI, read specific vars in npzread - #39

Merged
fhs merged 2 commits into
fhs:masterfrom
jishnub:npzreadvars
Nov 12, 2020
Merged

update CI, read specific vars in npzread#39
fhs merged 2 commits into
fhs:masterfrom
jishnub:npzreadvars

Conversation

@jishnub

@jishnub jishnub commented Nov 10, 2020

Copy link
Copy Markdown
Contributor

Firstly this PR adds the option to read specific variables in npzread instead of all the variables.

Secondly it adds docstrings to npzread and npzwrite. It also adds a documentation generation workflow.

Thirdly it updates the CI to github actions from travis, and updates Tagbot as suggested here. Tbh I'm not totally sure if this is done correctly.

@jishnub

jishnub commented Nov 10, 2020

Copy link
Copy Markdown
Contributor Author

The readme badge needs to be updated, perhaps this can be done after merging.

@fhs fhs left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Thanks!

I'm don't know how the documentation deployment works. From a brief look at the docs, I guess it pushes the generated documentation to this repo?

I would've preferred a separate PR for the npzread changes, but it's fine.

Comment thread src/NPZ.jl Outdated
Comment thread docs/Project.toml Outdated
Comment thread .github/workflows/ci.yml
Comment thread .github/workflows/ci.yml Outdated
@jishnub

jishnub commented Nov 12, 2020

Copy link
Copy Markdown
Contributor Author

yes I realize now that separate PRs would have been a better idea.

The documentation workflow pushes commits to the gh-pages branch. It might be necessary to select this branch as the source of github pages from settings. Previously I've only used travis for this, and there might be issues with using github actions for this. Reading through the issue it seems that using an SSH deploy key should get around this, so I'm adding this for the time being.

@codecov-io

Copy link
Copy Markdown

Codecov Report

❗ No coverage uploaded for pull request base (master@f4272a5). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master      #39   +/-   ##
=========================================
  Coverage          ?   85.27%           
=========================================
  Files             ?        1           
  Lines             ?      163           
  Branches          ?        0           
=========================================
  Hits              ?      139           
  Misses            ?       24           
  Partials          ?        0           

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 f4272a5...9fc88a2. Read the comment docs.

@fhs fhs left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Thanks!

@fhs
fhs merged commit 04be36a into fhs:master Nov 12, 2020
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.

3 participants