Skip to content

feat: add --sdm short opt for --deployment#2551

Merged
johanneskoester merged 5 commits intosnakemake:mainfrom
mbhall88:main
Jan 8, 2024
Merged

feat: add --sdm short opt for --deployment#2551
johanneskoester merged 5 commits intosnakemake:mainfrom
mbhall88:main

Conversation

@mbhall88
Copy link
Copy Markdown
Member

@mbhall88 mbhall88 commented Dec 21, 2023

Description

The new --software-deployment-method/--deployment-method/--deployment is probably a heavily used option for most users, so I think it would benefit from a shorthand option as it is quite verbose. Seems -m is available and is kind of related.

I've also updated the docs with some references to this shorthand version and replaced some longform usage with the short option, ensuring it is made clear what the shorthand option is an alias for. Happy to change this though.

QC

  • The PR contains a test case for the changes or the changes are already covered by an existing test case.
  • 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).

@johanneskoester
Copy link
Copy Markdown
Contributor

Good idea, but I think I would prefer --sdm instead (instead of a single letter code). THis way, it should be easier to remember and decipher.

@mbhall88
Copy link
Copy Markdown
Member Author

Good idea, but I think I would prefer --sdm instead (instead of a single letter code). THis way, it should be easier to remember and decipher.

Done

@mbhall88 mbhall88 changed the title feat: add -m short opt for --deployment feat: add --sdm short opt for --deployment Dec 22, 2023
@mbhall88
Copy link
Copy Markdown
Member Author

mbhall88 commented Dec 22, 2023

@johanneskoester i didn’t really touch any code except to add the short option, so I don’t know why tests are failing…

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Jan 3, 2024

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@mbhall88
Copy link
Copy Markdown
Member Author

mbhall88 commented Jan 3, 2024

Ah it was because when I went from -m to --sdm it renames the option to args.sdm rather than args.software_deployment_method

@johanneskoester johanneskoester merged commit fd8b4b0 into snakemake:main Jan 8, 2024
@johanneskoester
Copy link
Copy Markdown
Contributor

Thanks!

johanneskoester pushed a commit that referenced this pull request Jan 8, 2024
🤖 I have created a release *beep* *boop*
---


##
[8.1.0](v8.0.1...v8.1.0)
(2024-01-08)


### Features

* add --sdm short opt for --deployment
([#2551](#2551))
([fd8b4b0](fd8b4b0))


### Bug Fixes

* add mamba to docker image
([eb0c884](eb0c884))
* correctly report lineno
([#2584](#2584))
([967a0d7](967a0d7))
* move apptainer into separate env in docker image
([94e9e2c](94e9e2c))
* single line f-string format error in py3.12
([#2588](#2588))
([87c06c0](87c06c0))


### Documentation

* add note on google executor backends
([ff8683c](ff8683c))
* diff 7 and 8
([#2561](#2561))
([ba22e07](ba22e07))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants