Skip to content

Commit 07d212b

Browse files
authored
Docs review (#7)
1 parent c698e0e commit 07d212b

2 files changed

Lines changed: 12 additions & 10 deletions

File tree

HOWTO.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,26 @@
33
This guide provides getting started instructions for the official [Atlas CLI](https://github.com/mongodb/mongodb-atlas-cli) GitHub Action.
44

55
This Action allows you to run any Atlas CLI command in your own GitHub workflows.
6-
By default, the latest Atlas CLI version is used. The version can be configured with the 'version' input parameter.
6+
By default, this Action uses the latest version of the Atlas CLI. The version can be configured with the 'version' input parameter, but only the
7+
latest version is officially supported.
78

89
## Complete the prerequisites
910

1011
Before you begin, complete the following prerequisites:
11-
1. Configure Atlas CLI API Keys for the organisation or project that will be used in the Action.
12+
13+
1. [Configure Atlas CLI API Keys](https://www.mongodb.com/docs/atlas/configure-api-access/) for your organization or project.
1214
2. Add the API Keys to the [repository secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets).
13-
3. For authentication the environment variables MONGODB_ATLAS_PUBLIC_API_KEY and MONGODB_ATLAS_PRIVATE_API_KEY need to be set to the configured API keys in the workflow.
15+
3. Set the environment variables `MONGODB_ATLAS_PUBLIC_API_KEY` and `MONGODB_ATLAS_PRIVATE_API_KEY` to the Atlas CLI API Keys you configured.
1416
See [Atlas CLI Environment Variables](https://www.mongodb.com/docs/atlas/cli/stable/atlas-cli-env-variables/) for all supported environment variables.
1517

1618
## Configuration
1719

1820
To run CLI commands with this Action you can either use custom commands (see Basic workflow below) or use the configuration parameters
19-
to run predefined workflows. Check out the [action.yml](action.yml) to find out which inputs/outputs are available.
21+
to run predefined workflows. See [action.yml](action.yml) for available inputs/outputs.
2022

2123
## Example workflows
2224

23-
See [here](https://github.com/mongodb/atlas-github-action/blob/main/.github/workflows/test.yml) for more examples.
25+
See [test.yml](https://github.com/mongodb/atlas-github-action/blob/main/.github/workflows/test.yml) for more examples.
2426

2527
### Basic
2628
This workflow installs the CLI and prints the CLI version.
@@ -42,8 +44,8 @@ jobs:
4244
```
4345
4446
### Setup and Teardown
45-
This workflow sets up a project and a free cluster. It retrieves the connection string which can be used to connect to the created cluster.
46-
Afterwards it deletes the project and cluster that was set up.
47+
This workflow sets up a project and creates a free cluster. It retrieves the connection string which can be used to connect to the new cluster.
48+
Afterwards, it deletes the project and cluster.
4749
```yaml
4850
on: [push]
4951

@@ -83,4 +85,4 @@ jobs:
8385
with:
8486
delete-project-id: ${{ steps.create-project.outputs.create-project-id }}
8587
delete-cluster-name: test-cluster
86-
```
88+
```

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ See our [HOWTO.md](HOWTO.md) guide.
88

99
## Limitations
1010
1. This Action only supports Linux runners (e.g. ubuntu-latest).
11-
2. Officially Atlas CLI only supports the latest CLI version.
11+
2. This Action only officially supports the latest version of the Atlas CLI.
1212

1313
## License
1414

15-
The Atlas CLI GitHub Action is released under the Apache 2.0 license. See [LICENSE](LICENSE)
15+
The Atlas CLI GitHub Action is released under the Apache 2.0 license. See [LICENSE](LICENSE).

0 commit comments

Comments
 (0)