Updating README Usability #13
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
willmarks
commented
Jul 30, 2021
willmarks
commented
Jul 30, 2021
willmarks
commented
Jul 30, 2021
README.md
Outdated
| __Allowed Values:__ Success, Failed, Canceled, Queued, Running, Unknown, Custom | ||
|
|
||
| 1. `FAROS_VCS_SOURCE` / `--vcs_source "<vcs_source>"` | ||
| The version control source system that stores the code that is being built (i.e. GitHub, GitLab, Bitbucket) Please note that this field is case sensitive. If you have a feed that connects to one of these sources, this name must match exactly to be correctly associated. |
There was a problem hiding this comment.
I created #14 to actually flesh out these source systems etc to mitigate issues from capitalization etc. The PR is already kinda big tho so I was just going to do it in a subsequent PR.
tovbinm
reviewed
Aug 2, 2021
tovbinm
reviewed
Aug 2, 2021
tovbinm
reviewed
Aug 2, 2021
tovbinm
reviewed
Aug 2, 2021
tovbinm
reviewed
Aug 2, 2021
tovbinm
reviewed
Aug 2, 2021
tovbinm
reviewed
Aug 2, 2021
tovbinm
reviewed
Aug 2, 2021
tovbinm
reviewed
Aug 3, 2021
README.md
Outdated
| | Flag | Description | | ||
| | ------------- | -------------------------------------- | | ||
| | --dry_run | Print the event instead of sending. | | ||
| | -s / --silent | Unexceptional output will be silenced. | |
willmarks
commented
Aug 3, 2021
| @@ -22,13 +22,14 @@ FAROS_GRAPH_DEFAULT="default" | |||
| FAROS_URL_DEFAULT="https://prod.api.faros.ai" | |||
| FAROS_ORIGIN_DEFAULT="Faros_Script_Event" | |||
| FAROS_SOURCE_DEFAULT="Faros_Script" | |||
| FAROS_APP_PLATFORM_DEFAULT="NA" | |||
| FAROS_APP_PLATFORM_DEFAULT="" | |||
There was a problem hiding this comment.
Shubha requested that I change this default to "" so I just included it as it also required a readme change.
|
@willmarks please create a new release |
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 FA-6
About
More information is needed for each field so that usage can be more self-sufficient. I also reworked where a couple fields were required and optional. Notably, commit sha is now only required for build and build_deployment as it was not being used for deployment.