maintaining packages in our lab

It would be great if we could have a doc on our wiki that extends https://github.com/bioinfo-ucsd/wiki/issues/5 and provides some tips on how to set up a package/tool in our lab so that others can maintain the package once the original author leaves the lab. Some things we could include:

[ ] the package should be in our GitHub org so that everyone has push access to it
[ ] the repo should have main branch protections and PRs should ideally require at least one review from anyone in the lab. Nice to have: branches should get deleted automatically upon PR merging
[ ] upon transfer into the lab org, an admin of our org should create a GitHub team comprised of designated "maintainers" of the project, who should get admin access to the repo
[ ] pypi trusted publishing should allow others to publish new pypi versions without needing access to the original pypi account
- [ ] and ideally a GitHub actions workflow for publishing so that anyone (even those who aren't maintainers) can trigger a release
- [ ] a GitHub environment that requires approval of all releases by the "maintainers"
[ ] in case access to the original pypi account is needed, Melissa should be assigned as a collaborator of the pypi account
[ ] Melissa should be assigned as a collaborator of the readthedocs account
[ ] the readthedocs account should allow for PR previews
[ ] ideally, the readthedocs account will have both a "stable" and "latest" version and automatic versioning enabled
[ ] ~~the GitHub team should be listed as a maintainer in the corresponding bioconda recipe, if there is one~~ (it turns out that this actually doesn't work, after all)
[ ] ideally, a .devcontainer.json file should be available in the repository to automatically and reproducibly set up a dev environment through github codespaces

gymrek-lab / gymreklab.github.io

maintaining packages in our lab #64