Merge branch 'main' of github.com:snakemake/snakemake-interface-executor-plugins

Author: johanneskoester

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [8.1.2](https://github.com/snakemake/snakemake-interface-executor-plugins/compare/v8.1.1...v8.1.2) (2023-12-12)
+
+
+### Documentation
+
+* CommonSettings ([#50](https://github.com/snakemake/snakemake-interface-executor-plugins/issues/50)) ([85b995d](https://github.com/snakemake/snakemake-interface-executor-plugins/commit/85b995d726cd941ea0f6e43b6217e95140a82327))
+
+## [8.1.1](https://github.com/snakemake/snakemake-interface-executor-plugins/compare/v8.1.0...v8.1.1) (2023-12-08)
+
+
+### Bug Fixes
+
+* allow value of none for shared fs usage setting ([d334869](https://github.com/snakemake/snakemake-interface-executor-plugins/commit/d33486933f41f2bccd099e2cab90b2d1a854def2))
+
 ## [8.1.0](https://github.com/snakemake/snakemake-interface-executor-plugins/compare/v8.0.2...v8.1.0) (2023-11-30)
 
 

README.md

@@ -60,7 +60,10 @@ common_settings = CommonSettings(
     # plugins (snakemake-executor-plugin-dryrun, snakemake-executor-plugin-local)
     # are expected to specify False here.
     non_local_exec=True,
+    # Whether the executor implies to not have a shared file system
     implies_no_shared_fs=True,
+    # whether to deploy workflow sources to default storage provider before execution
+    job_deploy_sources=True,
     # whether arguments for setting the storage provider shall be passed to jobs
     pass_default_storage_provider_args=True,
     # whether arguments for setting default resources shall be passed to jobs

pyproject.toml

@@ -5,7 +5,7 @@ license = "MIT"
 name = "snakemake-interface-executor-plugins"
 packages = [{include = "snakemake_interface_executor_plugins"}]
 readme = "README.md"
-version = "8.1.0"
+version = "8.1.2"
 
 [tool.poetry.dependencies]
 argparse-dataclass = "^2.0.0"

snakemake_interface_executor_plugins/settings.py

@@ -20,10 +20,10 @@ class CommonSettings:
     ----------
     non_local_exec : bool
         Whether to execute jobs locally or on a cluster.
-    force_no_shared_fs : bool
-        Whether to the executor implies to not have a shared file system.
+    implies_no_shared_fs : bool
+        Whether the executor implies to not have a shared file system.
     dryrun_exec : bool
-        Whether to jobs will be executed in dry-run mode.
+        Whether jobs will be executed in dry-run mode.
     job_deploy_sources : bool
         Whether to deploy workflow sources before job execution. This is e.g.
         needed when remote jobs are guaranteed to be not executed on a shared