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 github action for release and doc building #90

Merged
merged 4 commits into from
Mar 3, 2023

Conversation

weikang9009
Copy link
Member

@weikang9009 weikang9009 commented Mar 3, 2023

Add Github actions for release and docs building - resolve part of the infrastructure issue #86

@codecov
Copy link

codecov bot commented Mar 3, 2023

Codecov Report

Merging #90 (991951d) into master (f70619f) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #90   +/-   ##
=======================================
  Coverage   52.47%   52.47%           
=======================================
  Files          12       12           
  Lines        1841     1841           
  Branches      315      315           
=======================================
  Hits          966      966           
  Misses        819      819           
  Partials       56       56           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@weikang9009 weikang9009 changed the title add github action for release add github action for release and doc building Mar 3, 2023
@martinfleis
Copy link
Member

I'll leave the review of the docs action to @jGaboardi but it will probably need some other action as this is essentially a move from RTD to PySAL.org/pointpats. Not sure how that works.

@weikang9009
Copy link
Member Author

Based on the notes in the build_docs.yml (this file is borrowed from the subpackage_template.

# Notes:
#   - After the first run of this workflow:
#       - Within the project repo, navigate to Setting/Github Pages
#       - set `the source pbranch to `gh-pages/(root))`.
#   - Uncomment evertything below the following line to enable the workflow.

The workflow needs to be integrated into the repo before configuring the setting of github page. @jGaboardi let me know if my understanding is incorrect.

@jGaboardi
Copy link
Member

The workflow needs to be integrated into the repo before configuring the setting of github page. @jGaboardi let me know if my understanding is incorrect.

@weikang9009, yes I believe your understanding is correct (if I remember correctly).

this is essentially a move from RTD to PySAL.org/pointpats. Not sure how that works.

I also can't remember how this works since it has been some years since I've used RTD. In any case, I think it's a good idea to retain the readthedocs.yml file for now until things are worked out.

@jGaboardi
Copy link
Member

Also, @weikang9009 do you have admin privileges here in pointpats? We should update the default branch from master to main after this PR if you do.

@weikang9009 weikang9009 merged commit ae70fbd into pysal:master Mar 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants