Skip to content
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.

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

Update Readme #6

Merged
merged 1 commit into from
Jun 9, 2024
Merged
Changes from all commits
Commits
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
43 changes: 42 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,46 @@
[![CodeQL](https://github.com/dbsnapper/install-dbsnapper-agent-action/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/dbsnapper/install-dbsnapper-agent-action/actions/workflows/codeql-analysis.yml)
[![Coverage](./badges/coverage.svg)](./badges/coverage.svg)

This action installs the [DBSnapper](https://dbsnapper.com) agent on a runner as
## Overview

This action installs the [DBSnapper](https://dbsnapper.com) Agent on a runner as
part of a GitHub Actions workflow.

## Usage

The action takes an optional `version` input that specifies the version of the
Agent to install. If no version is specified, the latest version is installed.

```yaml
steps:
- name: Install DBSnapper Agent
uses: dbsnapper/install-dbsnapper-agent-action@v1
with:
version: latest
```

## Sample DBSnapper job

Building on the above example, you can use a job similar to the following to run
a DBSnapper command such as this one that lists available targets:

```yaml
dbsnapper:
runs-on: ubuntu-latest
env:
# Provide the minimum required DBSnapper environment variables
# to run the DBSnapper agent in Cloud mode,
# without a configuration file
DBSNAPPER_SECRET_KEY: ${{ secrets.DBSNAPPER_SECRET_KEY }}
DBSNAPPER_AUTHTOKEN: ${{ secrets.DBSNAPPER_AUTHTOKEN }}
steps:
- name: Install DBSnapper Agent
uses: dbsnapper/install-dbsnapper-agent-action@v1
with:
version: latest
- name: Run DBSnapper List Targets
run: dbsnapper targets
```

More information on the DBSnapper Agent and its usage can be found in the
[DBSnapper documentation](https://docs.dbsnapper.com).
Loading