diff --git a/CHANGELOG.md b/CHANGELOG.md index 2b00fb3..804e28c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/README.md b/README.md index 998c639..19dc816 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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