Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document auto dois opt-out setting #297

Open
wants to merge 7 commits into
base: hotfix/1.16.1
Choose a base branch
from

Conversation

denis-yuen
Copy link
Member

@denis-yuen denis-yuen commented Dec 16, 2024

Description
Document DOI opt-out option in templates and in the DOI article.

View draft at https://docs.dockstore.org/en/feature-document_enable_auto_doi/

Issue
https://ucsc-cgl.atlassian.net/browse/SEAB-6833

Please make sure that you've checked the following before submitting your pull request. Thanks!

@denis-yuen denis-yuen self-assigned this Dec 16, 2024
@denis-yuen denis-yuen mentioned this pull request Dec 16, 2024
2 tasks
@denis-yuen denis-yuen changed the title Feature/document enable auto doi2 document auto dois opt-out setting Dec 16, 2024
@denis-yuen denis-yuen marked this pull request as ready for review December 16, 2024 20:42
docs/end-user-topics/dois.rst Outdated Show resolved Hide resolved
@@ -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: <Boolean>

# 'enableAutoDois' is a workflow-wide setting that will affect ALL branches/tags; only set this as needed in a main branch
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Beyond the scope of this PR, but this statement got me thinking, maybe the web service should only honor this and other workflow-level scoped settings if on the GitHub default branch.

Even with this advice, if a user reads it, it's going to be hard to do; if you create a new branch from the default branch, the .dockstore.yml is copied to the new branch.

No need to change anything here; I'll create a ticket for this idea; not sure if it's feasible.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

4 participants