Skip to content

Commit

Permalink
docs: added changelog info for >v7.19.1 parsing error of "hh:mm:ss" t…
Browse files Browse the repository at this point in the history
…ime format in runtime resource (#2189)

### Description

<!--Add a description of your PR here-->
1. Added info to changelog features for version 7.20.0 about how the
human friendly time format "1d" addition removed the ability for
snakemake to parse time format "hh:mm:ss"
([b1ca68a](b1ca68a))
([#2154](#2154))

2. Added additional information under the bug fixes subheader: human
friendly resource definitions introduce inability to parse slurm
specific time format (e.g. "hh:mm:ss"). New time format (e.g. "1d") adds
portability among various job schedulers and clusters
([b1ca68a](b1ca68a))
([#2154](#2154))

3. Included test case - tested on snakemake versions 7.19.1, 7.20.0, and
7.24.2
([61c0a9a](61c0a9a))
    - 7.19.1 - runtime="00:30:00" [&check;] = RUNS
    - 7.20.0 - runtime="00:30:00" [] = FAILS
    - 7.24.2 - runtime="00:30:00" [] = FAILS

### QC
<!-- Make sure that you can tick the boxes below. -->

*[&check;] The PR contains a test case for the changes or the changes
are already covered by an existing test case.
*[&check;] The documentation (`docs/`) is updated to reflect the changes
or this is not necessary (e.g. if the change does neither modify the
language nor the behavior or functionalities of Snakemake).
  • Loading branch information
ncherric committed Apr 28, 2023
1 parent a572fb7 commit 2889f38
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 1 deletion.
4 changes: 3 additions & 1 deletion CHANGELOG.md
Expand Up @@ -146,7 +146,8 @@

* add tes token ([#1966](https://github.com/snakemake/snakemake/issues/1966)) ([59a8fa0](https://github.com/snakemake/snakemake/commit/59a8fa04c4c6b113775fe11228b82510ecd36cb8))
* Add token auth to GitLab/GitHub hosting providers ([#1761](https://github.com/snakemake/snakemake/issues/1761)) ([e03a3b4](https://github.com/snakemake/snakemake/commit/e03a3b42eea89d512290bf98ee7d77ce2e17447c)), closes [#1301](https://github.com/snakemake/snakemake/issues/1301)
* allow for human friendly resource definitions (e.g. mem="5GB", runtime="1d") ([#1861](https://github.com/snakemake/snakemake/issues/1861)) ([24610ac](https://github.com/snakemake/snakemake/commit/24610ac75849d543fc38c83fb2454fa4f9b42075))
* allow for human friendly resource definitions (e.g. mem="5GB", runtime="1d") which deprecates slurm constrained time format (e.g. runtime="hh:mm:ss") ([#1861](https://github.com/snakemake/snakemake/issues/1861)) ([24610ac](https://github.com/snakemake/snakemake/commit/24610ac75849d543fc38c83fb2454fa4f9b42075)) ([#2154](https://github.com/snakemake/snakemake/issues/2154))



### Bug Fixes
Expand All @@ -166,6 +167,7 @@
* slurm default_resources quoting ([#2043](https://github.com/snakemake/snakemake/issues/2043)) ([47d3fc3](https://github.com/snakemake/snakemake/commit/47d3fc3eef8ebe54df8b77f100fc2ab3fa36c190))
* Update list of python versions in classifiers ([#2020](https://github.com/snakemake/snakemake/issues/2020)) ([7a98100](https://github.com/snakemake/snakemake/commit/7a98100ba92b0174c8ead3ae715042c1ab710c61))
* use short argument name for `--chdir` for compatibility with Slurm &lt;=v17 ([#2040](https://github.com/snakemake/snakemake/issues/2040)) ([a9ed3ec](https://github.com/snakemake/snakemake/commit/a9ed3ec3e823442810388fce8a17ba4950bbdaa2))
* human friendly resource definitions introduce inability to parse slurm specific time format (e.g. "hh:mm:ss"). New time format (e.g. "1d") adds portability among various job schedulers and clusters ([#2154](https://github.com/snakemake/snakemake/issues/2154))


### Documentation
Expand Down
17 changes: 17 additions & 0 deletions tests/test_github_issue2154/Snakefile
@@ -0,0 +1,17 @@
# Snakemake version > 7.19.0

rule all:
input:
"test.out"

rule test:
input:
testIN="test.in",
resources:
runtime="00:30:00",
output:
testOUT="test.out",
shell:
"""
cp {input.testIN} {output.testOUT}
"""
1 change: 1 addition & 0 deletions tests/test_github_issue2154/test.in
@@ -0,0 +1 @@
TestFile for issue 2154

0 comments on commit 2889f38

Please sign in to comment.