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 a Python release process to hubverse-org documentation #233

Closed
2 tasks
bsweger opened this issue Jan 9, 2025 · 2 comments · Fixed by #241
Closed
2 tasks

Add a Python release process to hubverse-org documentation #233

bsweger opened this issue Jan 9, 2025 · 2 comments · Fixed by #241
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@bsweger
Copy link
Contributor

bsweger commented Jan 9, 2025

Background

As the Reich Lab gets ready to release a software package to Python's package index (Cladetime), we're leaning towards adopting the Hubverse release process as designed and documented by @zkamvar.

The versioning and workflow are not language-specific, but the mechanics of publication are. Releasing Cladetime will be a good exercise in working out a Python publication process, and we should document that process in the Hubverse docs because:

  • The Hubverse is planning to develop a Python version of hubData, which will presumably be released on PyPI
  • The Reich Lab would prefer to use Hubverse release documentation as a reference, rather than maintaining our own process.

Definition of done

  • hubDocs is updated as described in this comment
  • Content that was moved from hubDevs to hubDocs is removed or redirected in the former
@bsweger bsweger converted this from a draft issue Jan 9, 2025
@bsweger
Copy link
Contributor Author

bsweger commented Jan 9, 2025

@zkamvar What do you think about this? Does it make sense to add Python documentation to an article tied to an R package?

@zkamvar
Copy link
Member

zkamvar commented Jan 9, 2025

@zkamvar What do you think about this? Does it make sense to add Python documentation to an article tied to an R package?

Given that the article for the release process in the hub devs package has no R or quarto-specific features that are not also in readthedocs, we should probably just move the relevant sections here and then keep the R-specific process in the hubDevs package and add a python-specific process to a separate page here, so the structure would look like:

docs/source/developer/
├─ index.md
├─ release-process.md
├─ hotfix.md
├─ r.md # provides link out to hubDevs vignettes
└─ python.md

@zkamvar zkamvar added the documentation Improvements or additions to documentation label Jan 9, 2025
@bsweger bsweger moved this from Todo to Up Next in hubverse Development overview Jan 23, 2025
@bsweger bsweger moved this from Up Next to In Progress in hubverse Development overview Jan 23, 2025
@bsweger bsweger self-assigned this Jan 23, 2025
@bsweger bsweger moved this from In Progress to Ready for Review in hubverse Development overview Jan 29, 2025
@github-project-automation github-project-automation bot moved this from Ready for Review to Done in hubverse Development overview Jan 31, 2025
bsweger added a commit to hubverse-org/hubDevs that referenced this issue Jan 31, 2025
General release process documentation has moved to the "developer" section
of the Hubverse documentation: hubverse-org/hubDocs#233

This changeset removes that documentation from hubDevs and links to the
relocated version (excepting the R release checklist, which remains in hubDevs per
hubverse-org/hubDocs#233 (comment)).
bsweger added a commit to hubverse-org/hubDevs that referenced this issue Jan 31, 2025
General release process documentation has moved to the "developer" section
of the Hubverse documentation: hubverse-org/hubDocs#233

This changeset removes that documentation from hubDevs and links to the
relocated version (excepting the R release checklist, which remains in hubDevs per
hubverse-org/hubDocs#233 (comment)).
bsweger added a commit to hubverse-org/hubDevs that referenced this issue Jan 31, 2025
General release process documentation has moved to the "developer" section
of the Hubverse documentation: hubverse-org/hubDocs#233

This changeset removes that documentation from hubDevs and links to the
relocated version (excepting the R release checklist, which remains in hubDevs per
hubverse-org/hubDocs#233 (comment)).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants