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

Prepare for scpcaTools release v0.4.1 #285

Closed
13 tasks done
jashapiro opened this issue Oct 29, 2024 · 1 comment
Closed
13 tasks done

Prepare for scpcaTools release v0.4.1 #285

jashapiro opened this issue Oct 29, 2024 · 1 comment
Labels
release Issues related new release versions

Comments

@jashapiro
Copy link
Member

jashapiro commented Oct 29, 2024

This release should be just the docker update... do we want it as 0.4.1 or something like 0.4.0a, I wonder, if there are no code changes?

Update, there was a code change to fix how we handle unset seeds, so 0.4.1 will be the release!

Steps for a new release of scpcaTools

Preparing for the release and testing

  • 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.
  • Update DESCRIPTION with new version number.
  • 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.
  • Test the new docker build in scpca-nf
    • Create a branch in scpca-nf for testing the latest Docker version from the main branch.
    • 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.
    • If necessary, update the scpca-nf workflow to accommodate changes in the scpcaTools package
    • 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

  • On the releases page, choose Draft a new release.
  • 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.
  • 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:
  • Publish the release!
@jashapiro jashapiro added the release Issues related new release versions label Oct 29, 2024
@jashapiro
Copy link
Member Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release Issues related new release versions
Projects
None yet
Development

No branches or pull requests

1 participant