diff --git a/docs/assets/templates/notebooks/template-big.dockstore.yml b/docs/assets/templates/notebooks/template-big.dockstore.yml index 40efd57d..17c3360c 100644 --- a/docs/assets/templates/notebooks/template-big.dockstore.yml +++ b/docs/assets/templates/notebooks/template-big.dockstore.yml @@ -63,6 +63,11 @@ notebooks: # A value of true will automatically display the latest tag updated as default. # A value of false will retain the default version that has been specified via the Dockstore UI. latestTagAsDefault: + + # 'enableAutoDois' is a notebook-wide setting that will affect ALL branches/tags; only set this as needed in a main branch + # to control whether DOIs are automatically issued for tags. Implicit default: True, can only be overridden as False + # A value of false will disable automatic DOIs, DOIs will only be issued on demand. + enableAutoDois: # The optional filters section allow specifying sets of Git branches and tags to include for the notebook. # If no filters are given, all branches and tags are included. diff --git a/docs/assets/templates/notebooks/template-small.dockstore.yml b/docs/assets/templates/notebooks/template-small.dockstore.yml index e9f87359..ca4d7dd3 100644 --- a/docs/assets/templates/notebooks/template-small.dockstore.yml +++ b/docs/assets/templates/notebooks/template-small.dockstore.yml @@ -14,4 +14,4 @@ notebooks: authors: - name: email: - topic: + topic: \ No newline at end of file diff --git a/docs/assets/templates/services/template-big.dockstore.yml b/docs/assets/templates/services/template-big.dockstore.yml index d336fbc3..c4e7c1d5 100644 --- a/docs/assets/templates/services/template-big.dockstore.yml +++ b/docs/assets/templates/services/template-big.dockstore.yml @@ -33,6 +33,11 @@ service: # Omitting the publish setting leaves the publish-state unchanged (recommended for all non-primary branches). publish: + # 'enableAutoDois' is a service-wide setting that will affect ALL branches/tags; only set this as needed in a main branch + # to control whether DOIs are automatically issued for tags. Implicit default: True, can only be overridden as False + # A value of false will disable automatic DOIs, DOIs will only be issued on demand. + enableAutoDois: + # These are files the Dockstore will index. They will be directly downloadable from Dockstore. Wildcards are not supported. files: diff --git a/docs/assets/templates/services/template-small.dockstore.yml b/docs/assets/templates/services/template-small.dockstore.yml index d4665b6d..56d46519 100644 --- a/docs/assets/templates/services/template-small.dockstore.yml +++ b/docs/assets/templates/services/template-small.dockstore.yml @@ -20,4 +20,4 @@ service: targetDirectory: files: : - description: + description: \ No newline at end of file diff --git a/docs/assets/templates/workflows/template-big.dockstore.yml b/docs/assets/templates/workflows/template-big.dockstore.yml index 45d77aef..b944ed68 100644 --- a/docs/assets/templates/workflows/template-big.dockstore.yml +++ b/docs/assets/templates/workflows/template-big.dockstore.yml @@ -65,6 +65,11 @@ workflows: # A value of true will automatically display the latest tag updated as default. # A value of false will retain the default version that has been specified via the Dockstore UI. latestTagAsDefault: + + # 'enableAutoDois' is a workflow-wide setting that will affect ALL branches/tags; only set this as needed in a main branch + # to control whether DOIs are automatically issued for tags. Implicit default: True, can only be overridden as False + # A value of false will disable automatic DOIs, DOIs will only be issued on demand. + enableAutoDois: # The optional filters section allow specifying sets of Git branches and tags to include for the workflow. # If no filters are given, all branches and tags are included. diff --git a/docs/assets/templates/workflows/template-small.dockstore.yml b/docs/assets/templates/workflows/template-small.dockstore.yml index ba2f82c9..4a4b4b31 100644 --- a/docs/assets/templates/workflows/template-small.dockstore.yml +++ b/docs/assets/templates/workflows/template-small.dockstore.yml @@ -9,4 +9,4 @@ workflows: authors: - name: email: - topic: + topic: \ No newline at end of file diff --git a/docs/end-user-topics/dois.rst b/docs/end-user-topics/dois.rst index c5d8c557..dbf2ae49 100644 --- a/docs/end-user-topics/dois.rst +++ b/docs/end-user-topics/dois.rst @@ -82,6 +82,18 @@ Automatically-generated DOIs: * Are editable by request to the Dockstore team * Will be editable via a Zenodo account in a subsequent Dockstore release +If you wish to override and disable this feature, you can opt-out on a per-workflow basis by adding the following setting to your `.dockstore.yml` files + +.. code-block:: yaml + + enableAutoDois: false + + +One rare case to potentially watch out for: if your workflows are tagged with your ORCID as an author +you may get a large number of notifications or workflows automatically added to your ORCID profile. +This will occur outside of Dockstore if you have the `ORCID Auto-Update `__ feature turned on in DataCite. +DataCite's auto-update feature is not aware of how Zenodo groups DOIs into one overall "concept" DOI and will import each version independently. + GitHub-Zenodo Generation ~~~~~~~~~~~~~~~~~~~~~~~~