Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/renehernandez/action-appfile
GitHub Action for appfile
https://github.com/renehernandez/action-appfile
Last synced: about 1 month ago
JSON representation
GitHub Action for appfile
- Host: GitHub
- URL: https://github.com/renehernandez/action-appfile
- Owner: renehernandez
- License: mit
- Created: 2020-11-21T13:42:47.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2020-11-22T14:03:16.000Z (about 4 years ago)
- Last Synced: 2024-11-30T07:17:38.874Z (about 1 month ago)
- Language: JavaScript
- Size: 5.74 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Actions for Appfile
This action enables you to manage Apps in the [DigitalOcean App Platform](https://www.digitalocean.com/products/app-platform/) services by installing [the `appfile` command-line client](https://github.com/renehernandez/appfile).
## Usage
To install the latest version of `appfile` and use it in GitHub Actions workflows, add the following step:
```yaml
- name: Install appfile
uses: renehernandez/[email protected]
```
`appfile` will now be available in the virtual environment and can be used directly in the following steps. You will need a [DigitalOcean personal access token](https://www.digitalocean.com/docs/api/create-personal-access-token/) to execute appfile commands. As an example, one common use case is syncing an App platform specification to create a review environment for your branch:
```yaml
- name: Deploy App in review environment
env:
DIGITALOCEAN_ACCESS_TOKEN: {{ secrets.DIGITALOCEAN_ACCESS_TOKEN }}
run: appfile -f ./do/appfile.yaml -e review sync
```
### Arguments
- `version` – (Optional) The version of `appfile` to install. If excluded, the latest release will be used.
## 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 `main` branch. (it will switch to `v1` branch once it is stable)
## License
This GitHub Action and associated scripts and documentation in this project are released under the [MIT License](LICENSE).