chore: add sami-cli specs #2
Open
+102
−2
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
Sanix-Darker
requested changes
Apr 11, 2022
Comment on lines
+34
to
+41
| |`version` | The version of the `sami.yaml` file it is set using semantic versionning `v0`| | ||
| |`service_name` | The name of the service you want to deploy. **Example: camerdevs** | ||
| |`type` | The type of deployment you want to use can be `swarm|k8s|cron` | ||
| |`pr_deploy` | Set wheter it is a pull request deployment or not. set to `false` by default | ||
| |`files` | Is a list of deployment files. for camerdevs it should be set to `- camerdevs-stack.yml` | ||
| |`oob` | The out of band field indicate which field and file should be edited when a deployment is performed, we could change the image sha of `service.api.image` field in the `camerdevs-stack.yml` file | ||
| |`oob.[].key.path` | Path to the field we want to edit in the deployment file | ||
| |`oob.[].key.file` | name of the file to the field we want to edit in the deployment file |
There was a problem hiding this comment.
Is it possible to add :
- a column "Required" to tell if the field is required or not
- a column for the variable type
- a column for dependency between other field (this field should be present only if this field is available...)
|
|
||
| | Fields | Description | | ||
| |--------------|-----------------------| | ||
| |`version` | The version of the `sami.yaml` file it is set using semantic versionning `v0`| |
There was a problem hiding this comment.
How the version can impact the implementation of the CLI ? 🤔
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.
No description provided.