Skip to content

Update README #2

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

Merged
brianlund merged 1 commit into from
Jul 23, 2026
Merged

Update README #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 8 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@ steps:
run: mongodump --uri="$MONGODB_URI" --archive=mongodb.archive --gzip
```

Use an exact version for reproducible workflows. `latest` is also accepted and
is the default:
Pin an exact version for reproducible workflows. Set version to latest to install the latest release:

```yaml
- uses: brianlund/setup-mongodb-database-tools@v1
Expand Down Expand Up @@ -69,16 +68,16 @@ Place the runner inside a VPC that can reach the DocumentDB cluster.

## Inputs

| Input | Description | Default |
| --- | --- | --- |
| Input | Description | Default |
| --------- | ----------------------------------------- | -------- |
| `version` | Exact Database Tools version, or `latest` | `latest` |

## Outputs

| Output | Description |
| --- | --- |
| `version` | Exact version installed |
| `path` | Directory containing the installed binaries |
| Output | Description |
| ----------- | ----------------------------------------------- |
| `version` | Exact version installed |
| `path` | Directory containing the installed binaries |
| `cache-hit` | `true` when restored from the runner tool cache |

## Supported runners
Expand Down Expand Up @@ -107,12 +106,7 @@ The action performs these checks:
4. Checks that `mongodump` reports the requested version.
5. Stores the verified installation in the runner tool cache.

The cache can be reused by later steps in the same job and by persistent
self-hosted runners. GitHub-hosted runners start each job on a fresh virtual
machine.

For security-sensitive workflows, pin third-party actions to a full commit SHA.
Maintainers move major tags such as `v1` to deliver compatible fixes.
Later steps in the same job and persistent self-hosted runners can reuse the cache.

## License and terms

Expand Down