pysal / pointpats

Planar Point Pattern Analysis in PySAL
https://pysal.org/pointpats/
BSD 3-Clause "New" or "Revised" License
83 stars 26 forks source link

add github action for release and doc building #90

Closed weikang9009 closed 1 year ago

weikang9009 commented 1 year ago

Add Github actions for release and docs building - resolve part of the infrastructure issue https://github.com/pysal/pointpats/issues/86

codecov[bot] commented 1 year ago

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.

martinfleis commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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.