Skip to content
This repository has been archived by the owner on Nov 16, 2023. It is now read-only.

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Edaena Salinas authored and Edaena Salinas committed Apr 23, 2020
1 parent 51de1c5 commit 05fd607
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/commands/data.json
Expand Up @@ -411,7 +411,8 @@
"required": true,
"inherit": "azure_devops.access_token"
}
]
],
"markdown": "## Description\n\nAppend an existing variable group in Azure DevOps project and its services.\n\n## Command Prerequisites\n\nThis command requires to have an existing bedrock project that was initialized\nwith `spk project init`. It also requires that the variable group to be added\nexists in the Azure DevOps project.\n\n## Example\n\nWhen an bedrock project repository is first initialized with `spk project init`,\nit will create a `bedrock.yaml` file that looks similar to this:\n\n```yaml\nrings:\n master:\n isDefault: true\nvariableGroups: []\nservices: []\n.\n.\n.\n```\n\nrunning `spk project append-variable-group my-vg` with a variable group name, in\nthis case `my-vg`, will add it under the `variables` section if it does not\nalready exist:\n\n```yaml\nrings:\n master:\n isDefault: true\nvariableGroups:\n - my-vg\nservices: []\n.\n.\n.\n```\n\nIf there are any `services` specified, it will add the variable group to its\ncorresponding `build-update-hld.yaml` file under the `variables` section:\n\n```yaml\nvariables:\n - group: my-vg\n```\n"
},
"project create-variable-group": {
"command": "create-variable-group <variable-group-name>",
Expand Down
49 changes: 49 additions & 0 deletions src/commands/project/append-variable-group.md
@@ -0,0 +1,49 @@
## Description

Append an existing variable group in Azure DevOps project and its services.

## Command Prerequisites

This command requires to have an existing bedrock project that was initialized
with `spk project init`. It also requires that the variable group to be added
exists in the Azure DevOps project.

## Example

When an bedrock project repository is first initialized with `spk project init`,
it will create a `bedrock.yaml` file that looks similar to this:

```yaml
rings:
master:
isDefault: true
variableGroups: []
services: []
.
.
.
```

running `spk project append-variable-group my-vg` with a variable group name, in
this case `my-vg`, will add it under the `variables` section if it does not
already exist:

```yaml
rings:
master:
isDefault: true
variableGroups:
- my-vg
services: []
.
.
.
```

If there are any `services` specified, it will add the variable group to its
corresponding `build-update-hld.yaml` file under the `variables` section:

```yaml
variables:
- group: my-vg
```

0 comments on commit 05fd607

Please sign in to comment.