clarify release/pre_release in README #100
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
#95 Signed-off-by: Aidan Oldershaw <aoldershaw@pivotal.io>
YoussB
suggested changes
Jun 30, 2020
README.md
Outdated
| also set to `false`). If `false`, only non-prerelease releases will be detected | ||
| and published. | ||
| **note:** if both `release` and `pre_release` are set to `true`, `put` | ||
| produces final releases and `check` detects both pre-releases and releases. |
There was a problem hiding this comment.
I didn't notice in the beginning that this is a different note, do you think it would be better to have both notes in the same place?
There was a problem hiding this comment.
Ah good point catch - I was hoping they'd appear on separate lines
I put line breaks between the notes and the body - let me know what you think
There was a problem hiding this comment.
when I read my comment again I noticed it is very vague 😁.
what I meant is to have all the notes related different setups in the same place, I will add it as a suggestion.
* space out notes * add link for semver compliant Signed-off-by: Aidan Oldershaw <aoldershaw@pivotal.io>
Signed-off-by: Aidan Oldershaw <aoldershaw@pivotal.io>
YoussB
suggested changes
Jul 2, 2020
README.md
Outdated
Comment on lines
34
to
36
| **note:** if both `release` and `pre_release` are set to `false`, `put` will | ||
| still produce final releases | ||
| **note:** releases must have [semver compliant](https://semver.org/#backusnaur-form-grammar-for-valid-semver-versions) tags to be detected. |
There was a problem hiding this comment.
Suggested change
| **note:** if both `release` and `pre_release` are set to `false`, `put` will | |
| still produce final releases | |
| **note:** releases must have [semver compliant](https://semver.org/#backusnaur-form-grammar-for-valid-semver-versions) tags to be detected. |
Signed-off-by: Aidan Oldershaw <aoldershaw@pivotal.io>
YoussB
approved these changes
Jul 6, 2020
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.
closes #95
Signed-off-by: Aidan Oldershaw aoldershaw@pivotal.io