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.

Sign up for GitHub

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

clarify release/pre_release in README #100

Merged
merged 4 commits into from
Jul 6, 2020
Merged

clarify release/pre_release in README #100

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c08678e
clarify release/pre_release in README
aoldershaw Jun 29, 2020
2199b0e
address pr feedback
aoldershaw Jul 2, 2020
d76f073
single line break between notes
aoldershaw Jul 2, 2020
82b43a4
combine note sections
aoldershaw Jul 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 15 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,21 @@ Fetches and creates versioned GitHub resources.
* `insecure`: *Optional. Default `false`.* When set to `true`, concourse will allow
insecure connection to your github API.

* `release`: *Optional. Default `true`.* When set to `true`, `put` produces
release and `check` detects releases. If `false`, `put` and `check` will ignore releases.
Note that releases must have semver compliant tags to be detected.

* `pre_release`: *Optional. Default `false`.* When set to `true`, `put` produces
pre-release and `check` detects prereleases. If `false`, only non-prerelease releases
will be detected and published. Note that releases must have semver compliant
tags to be detected.
If `release` and `pre_release` are set to `true`, `put` produces
release and `check` detects prereleases and releases.
* `release`: *Optional. Default `true`.* When set to `true`, `check` detects
final releases and `put` publishes final releases (as opposed to
pre-releases). If `false`, `check` will ignore final releases, and `put` will
publish pre-releases if `pre_release` is set to `true`
**note:** if both `release` and `pre_release` are set to `false`, `put` will
YoussB marked this conversation as resolved.
Show resolved Hide resolved
still produce final releases
**note:** releases must have semver compliant tags to be detected.
aoldershaw marked this conversation as resolved.
Show resolved Hide resolved

* `pre_release`: *Optional. Default `false`.* When set to `true`, `check`
detects pre-releases, and `put` will produce pre-releases (if `release` is
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.
Copy link
Member

Choose a reason for hiding this comment

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

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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

Copy link
Member

Choose a reason for hiding this comment

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

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.

**note:** releases must have semver compliant tags to be detected.
aoldershaw marked this conversation as resolved.
Show resolved Hide resolved

* `drafts`: *Optional. Default `false`.* When set to `true`, `put` produces
drafts and `check` only detects drafts. If `false`, only non-draft releases
Expand Down