Includes updates to functions for merging SCE's used in merge.nf from scpca-nf.
Preparing for the release and testing
[x] Are all of the issues planned for this release resolved? If there are any issues that are unresolved, mark this issue as blocked by those on ZenHub.
[x] Did all automated tests and the Docker build in this repo pass in CI? You may have to wait for the docker image to build. Check Github actions before proceeding to the next step.
[x] Test the new docker build in scpca-nf
[x] Create a branch in scpca-nf for testing the latest Docker version from the main branch.
[x] Update containers.config with the edge version of the scpca-tools container: SCPCATOOLS_CONTAINER = 'ghcr.io/alexslemonade/scpca-tools:edge' and push the branch to github.
[x] If necessary, update the scpca-nf workflow to accommodate changes in the scpcaTools package
[x] Perform a test run of the workflow with:
nextflow run AlexsLemonade/scpca-nf -r "<TESTBRANCH>" -profile batch,ccdl
If the [default run_ids](https://github.com/AlexsLemonade/scpca-nf/blob/main/config/profile_ccdl.config#L12-L13 for the workflow do not cover expected changes in this tools package, you may want to specify particular test samples or projects with the --run_id option (use your judgement).
Creating a release
[x] On the releases page, choose Draft a new release.
[x] In Choose a tag, type a new release number using semantic versioning (vX.X.X) (you did update the title of this issue to match, right?), then click Create a new tag: vX.X.X on publish.
[x] Write a description of the major changes in this release. You may want to start with the Auto-generated release notes to save time.
[ ] Save a draft to return to later if testing isn't done yet, otherwise:
Steps for a new release of
scpcaTools
Includes updates to functions for merging SCE's used in
merge.nf
fromscpca-nf
.Preparing for the release and testing
scpca-nf
main
branch.edge
version of the scpca-tools container:SCPCATOOLS_CONTAINER = 'ghcr.io/alexslemonade/scpca-tools:edge'
and push the branch to github.scpca-nf
workflow to accommodate changes in thescpcaTools
packagenextflow run AlexsLemonade/scpca-nf -r "<TESTBRANCH>" -profile batch,ccdl
If the [defaultrun_ids
](https://github.com/AlexsLemonade/scpca-nf/blob/main/config/profile_ccdl.config#L12-L13 for the workflow do not cover expected changes in this tools package, you may want to specify particular test samples or projects with the--run_id
option (use your judgement).Creating a release
Draft a new release
.Choose a tag
, type a new release number using semantic versioning (vX.X.X) (you did update the title of this issue to match, right?), then clickCreate a new tag: vX.X.X on publish
.