https://github.com/digitalocean/action-doctl
GitHub Actions for DigitalOcean - doctl
https://github.com/digitalocean/action-doctl
cicd digitalocean doctl github-actions hacktoberfest
Last synced: 18 days ago
JSON representation
GitHub Actions for DigitalOcean - doctl
- Host: GitHub
- URL: https://github.com/digitalocean/action-doctl
- Owner: digitalocean
- License: mit
- Created: 2018-11-01T15:22:26.000Z (over 6 years ago)
- Default Branch: v2
- Last Pushed: 2025-02-18T19:44:33.000Z (2 months ago)
- Last Synced: 2025-03-23T22:06:45.753Z (about 1 month ago)
- Topics: cicd, digitalocean, doctl, github-actions, hacktoberfest
- Language: JavaScript
- Homepage: https://www.digitalocean.com/
- Size: 703 KB
- Stars: 487
- Watchers: 8
- Forks: 41
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Actions for DigitalOcean
This action enables you to interact with [DigitalOcean](https://www.digitalocean.com/) services by installing [the `doctl` command-line client](https://github.com/digitalocean/doctl).
## Usage
To install the latest version of `doctl` and use it in GitHub Actions workflows, [create a DigitalOcean API token](https://docs.digitalocean.com/reference/api/create-personal-access-token/), [add it as a secret to your repository](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository), and add the following step to your workflow:
```yaml
- name: Install doctl
uses: digitalocean/action-doctl@v2
with:
token: ${{ secrets.DIGITALOCEAN_ACCESS_TOKEN }}
```
`doctl` will now be available in the virtual environment and can be used directly in following steps. As an example, one common use case is retrieving the credentials for a Kubernetes cluster hosted on DigitalOcean for use in a deployment workflow:
```yaml
- name: Save DigitalOcean kubeconfig
run: doctl kubernetes cluster kubeconfig save testing-cluster
```
See [this repository](https://github.com/do-community/example-doctl-action) for a full end-to-end example that also demonstrates building a Docker image, pushing it to a private DigitalOcean container registry, and using `kubectl` to deploy it to the Kubernetes cluster on DigitalOcean.
### Arguments
- `token` – (**Required**) A DigitalOcean personal access token ([more info](https://docs.digitalocean.com/reference/api/create-personal-access-token/)).
- `version` – (Optional) The version of `doctl` to install. If excluded, the latest release will be used.
- `no_auth` – (Optional) Set to `true` to skip the authentication step. The API `token` parameter is _Optional_ in this case.
- _Note:_ This can be useful when running in workflows in untrusted environments, or where auth isn't necessary (e.g. `doctl app spec validate --schema-only`)
- This depends on `doctl >= v1.101.0` (digitalocean/doctl#1450)
## Contributing
To install the needed dependencies, run `npm install`. The resulting `node_modules/` directory _is not_ checked in to Git.
Before submitting a pull request, run `npm run package` to package the code [using `ncc`](https://github.com/zeit/ncc#ncc). Packaging assembles the code including dependencies into one file in the `dist/` directory that is checked in to Git.
Pull requests should be made against the `v2` branch.
## License
This GitHub Action and associated scripts and documentation in this project are released under the [MIT License](LICENSE).