Add note for revision vs commitID [ci skip] #3540
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Per FD#2725, added a note explaining the difference in behavior between passing a git tag or branch name vs. passing a commit ID using -r. [ci skip] Signed-off-by: Llewellyn vd Berg <[email protected]>
pditommaso
reviewed
Jan 12, 2023
docs/metadata.rst
Outdated
| @@ -62,6 +62,8 @@ manifest Entries of the workflow manifest. | |||
| | Properties marked with a `*` are accessible only in the workflow completion and error handlers. See the `Completion handler`_ section for details. | |||
| | | |||
|
|
|||
| .. note:: | |||
| When passing a git tag or branch name using the ``-r`` argument in your CLI command, the ``workflow.revision`` and the associated ``workflow.commitId`` is populated. When passing only the Git commit ID using ``-r``, no ``workflow.revision`` is returned. | |||
There was a problem hiding this comment.
Suggested change
| When passing a git tag or branch name using the ``-r`` argument in your CLI command, the ``workflow.revision`` and the associated ``workflow.commitId`` is populated. When passing only the Git commit ID using ``-r``, no ``workflow.revision`` is returned. | |
| When passing a Git tag or branch name using the ``-r`` argument in your CLI command, the ``workflow.revision`` and the associated ``workflow.commitId`` is populated. When passing only the Git commit ID using ``-r``, no ``workflow.revision`` is returned. |
There was a problem hiding this comment.
Should not be "are populated" ?
There was a problem hiding this comment.
Certainly. Thanks for catching.
llewellyn-sl
commented
Jan 12, 2023
Signed-off-by: Llewellyn vd Berg <[email protected]>
pditommaso
approved these changes
Jan 12, 2023
l-modolo
pushed a commit
to l-modolo/nextflow
that referenced
this pull request
Jan 25, 2023
Signed-off-by: Llewellyn vd Berg <[email protected]>
marcodelapierre
pushed a commit
to marcodelapierre/nextflow
that referenced
this pull request
Jan 27, 2023
Signed-off-by: Llewellyn vd Berg <[email protected]> Signed-off-by: Marco De La Pierre <[email protected]>
abhi18av
pushed a commit
to abhi18av/nextflow
that referenced
this pull request
Oct 28, 2023
Signed-off-by: Llewellyn vd Berg <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Per FD#2725, added a note explaining the difference in behavior between passing a git tag or branch name vs. passing a commit ID using the
-rargument.Signed-off-by: Llewellyn vd Berg [email protected]