Skip to content

Commit

Permalink
Release 1.4.0. The final release to support snakemake version < 8
Browse files Browse the repository at this point in the history
  • Loading branch information
jdblischak committed Mar 18, 2024
1 parent 815fa68 commit d6cbdbe
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
## dev

## v1.4.0 - 2024-03-18

> [!WARNING]
> This is the final release to support Snakemake versions 5, 6, and 7.
Example that specifies memory in GB instead of MB (`mem-gb`)

Example that shares a profile between pipelines, and includes the name of the
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,15 @@ profile for Snakemake][slurm-official]. For more background, this [blog
post][sichong-post] by Sichong Peng nicely explains this strategy for replacing
`--cluster-config`.

> [!WARNING]
> The Slurm profile and documentation in this repository currently support
> Snakemake versions >= 5.15.0 and < 8.0.0. This is because Snakemake 8
> completely overhauled how it submits jobs to external clusters, which broke
> this and all the other existing profiles. We are in the process of updating
> the documentation to support Snakemake 8 (please help contribute if you can).
> If you plan to continue to use Snakemake 7, you can find the Snakemake 7
> version of the docs in the [v7 branch of this repository][v7].
## Features

* Only requires a single configuration file to get started submitting jobs to
Expand Down Expand Up @@ -349,3 +358,4 @@ warranties. To make it official, it's released under the [CC0][] license. See
[sichong-post]: https://www.sichong.site/workflow/2021/11/08/how-to-manage-workflow-with-resource-constraint.html
[slurm-official]: https://github.com/Snakemake-Profiles/slurm
[snakemake-aws-parallelcluster-slurm]: https://github.com/cbrueffer/snakemake-aws-parallelcluster-slurm
[v7]: https://github.com/jdblischak/smk-simple-slurm/tree/v7

0 comments on commit d6cbdbe

Please sign in to comment.