Skip to content

Commit 8bdac06

Browse files
committed
Merge branch 'hotfix/1.16.2'
2 parents 03f78b7 + f5b411b commit 8bdac06

File tree

7 files changed

+26
-10
lines changed

7 files changed

+26
-10
lines changed
-661 KB
Loading
66.4 KB
Loading

docs/assets/templates/notebooks/template-big.dockstore.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,8 @@ notebooks:
6565
latestTagAsDefault: <Boolean>
6666

6767
# 'enableAutoDois' is a notebook-wide setting that will affect ALL branches/tags; only set this as needed in a main branch
68-
# to control whether DOIs are automatically issued for tags. Implicit default: True, can only be overridden as False
68+
# to control whether DOIs are automatically issued for tags. Default: true.
69+
# A value of true will enable automatic DOIs.
6970
# A value of false will disable automatic DOIs, DOIs will only be issued on demand.
7071
enableAutoDois: <Boolean>
7172

docs/assets/templates/services/template-big.dockstore.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ service:
3434
publish:
3535

3636
# 'enableAutoDois' is a service-wide setting that will affect ALL branches/tags; only set this as needed in a main branch
37-
# to control whether DOIs are automatically issued for tags. Implicit default: True, can only be overridden as False
37+
# to control whether DOIs are automatically issued for tags. Default: true.
38+
# A value of true will enable automatic DOIs.
3839
# A value of false will disable automatic DOIs, DOIs will only be issued on demand.
3940
enableAutoDois: <Boolean>
4041

docs/assets/templates/tools/template-big.dockstore.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,12 @@ tools:
5858
# A value of true will automatically display the latest tag updated as default.
5959
# A value of false will retain the default version that has been specified via the Dockstore UI.
6060
latestTagAsDefault: <Boolean>
61+
62+
# 'enableAutoDois' is a tool-wide setting that will affect ALL branches/tags; only set this as needed in a main branch
63+
# to control whether DOIs are automatically issued for tags. Default: true.
64+
# A value of true will enable automatic DOIs.
65+
# A value of false will disable automatic DOIs, DOIs will only be issued on demand.
66+
enableAutoDois: <Boolean>
6167

6268
# The optional filters section allow specifying sets of Git branches and tags to include for the workflow.
6369
# If no filters are given, all branches and tags are included.

docs/assets/templates/workflows/template-big.dockstore.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ workflows:
6767
latestTagAsDefault: <Boolean>
6868

6969
# 'enableAutoDois' is a workflow-wide setting that will affect ALL branches/tags; only set this as needed in a main branch
70-
# to control whether DOIs are automatically issued for tags. Implicit default: True, can only be overridden as False
70+
# to control whether DOIs are automatically issued for tags. Default: true.
71+
# A value of true will enable automatic DOIs.
7172
# A value of false will disable automatic DOIs, DOIs will only be issued on demand.
7273
enableAutoDois: <Boolean>
7374

docs/end-user-topics/dois.rst

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,10 @@ When viewing the public page of an entry, the entry's concept DOI and the select
3636
:alt: Show DOIs
3737

3838
Dockstore only displays one DOI associated with a entry, even if there is more than one DOI, e.g., one generated by GitHub-Zenodo integration, and another generated by Dockstore.
39-
If this situation arises, you can control which DOI is displayed via your dashboard. Select the entry, then click "Manage DOIs", and you'll get a dialog like this. Select your choice
40-
and click "Save".
39+
If this situation arises, you can control which DOI is displayed via your dashboard.
40+
41+
Select the entry, then click Manage DOIs, and you'll get a dialog like this.
42+
Under DOI selection, click the radio button for the DOI you want to display and your DOI selection will update immediately. Click Done to close the dialog.
4143

4244

4345
.. figure:: /assets/images/docs/manage-dois.png
@@ -66,9 +68,6 @@ See :doc:`Creating Snapshots & Requesting DOIs </advanced-topics/snapshot-and-do
6668
Automatic Dockstore DOI Generation
6769
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6870

69-
.. note::
70-
This feature is currently only available on request. Please contact the Dockstore team at `discuss.dockstore.org <https://discuss.dockstore.org/t/opening-helpdesk-tickets/1506>`__ if you want to participate.
71-
7271
Dockstore will automatically mint a DOI for a version that corresponds to a Git tag, if:
7372

7473
* The entry is published on Dockstore
@@ -78,16 +77,24 @@ Dockstore will automatically mint a DOI for a version that corresponds to a Git
7877
Automatically-generated DOIs:
7978

8079
* Do not require a Zenodo account
81-
* Are minted in the Zenodo Dockstore community
80+
* Are minted in the `Zenodo Dockstore community <https://zenodo.org/communities/dockstore>`__
8281
* Are editable by request to the Dockstore team
8382
* Will be editable via a Zenodo account in a subsequent Dockstore release
8483

85-
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
84+
If you wish to override and disable this feature, you can opt-out on a per-entry basis.
85+
86+
For GitHub App entries, add the following setting to your .dockstore.yml files. This is an entry-wide setting that will affect ALL branches/tags; only set this as needed in a main branch.
87+
For more information, view the :doc:`full .dockstore.yml template </assets/templates/template>` for your entry which includes an explanation of this field.
8688

8789
.. code-block:: yaml
8890
8991
enableAutoDois: false
9092
93+
For hosted workflows and workflows that were registered using our :doc:`legacy registration methods </advanced-topics/legacy/workflow-legacy-registration>`,
94+
navigate to your workflow and click the Manage DOIs button. The Manage DOIs dialog will open and you can click the Automatic DOI Generation toggle to disable this feature.
95+
96+
.. figure:: /assets/images/docs/toggle-auto-doi.png
97+
:alt: Disable automatic DOI generation
9198

9299
One rare case to potentially watch out for: if your workflows are tagged with your ORCID as an author
93100
you may get a large number of notifications or workflows automatically added to your ORCID profile.

0 commit comments

Comments
 (0)