Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/renehernandez/appfile
Deploy App specs to DigitalOcean App Platform
https://github.com/renehernandez/appfile
apps cicd digitalocean
Last synced: 2 months ago
JSON representation
Deploy App specs to DigitalOcean App Platform
- Host: GitHub
- URL: https://github.com/renehernandez/appfile
- Owner: renehernandez
- License: mit
- Created: 2020-11-12T23:12:22.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-04-14T09:58:29.000Z (over 1 year ago)
- Last Synced: 2024-10-15T22:14:59.050Z (3 months ago)
- Topics: apps, cicd, digitalocean
- Language: Go
- Homepage: https://renehernandez.github.io/appfile
- Size: 7.61 MB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# appfile 
Deploy App Specs to DigitalOcean App Platform
## About
`appfile` is a declarative spec for deploying apps to the DigitalOcean App Platform. It lets you:
* Keep a directory of app spec values files and maintain changes in version control
* Apply CI/CD to configuration changes
* Visualize a diff of the changes to be applied
* See the status of your app
## Installation
`appfile` can be installed in several ways.
### Homebrew
You can install directly using the `renehernandez/taps` as follows:
```shell
$ brew install renehernandez/taps/appfile
```
### Download releases
You can always download the released binaries directly from the Github Releases page. For the latest releases check [here](https://github.com/renehernandez/appfile/releases)
### Github Action
You can leverage `appfile` with your Github Actions workflows, by using `action-appfile`:
* Marketplace: https://github.com/marketplace/actions/github-action-for-appfile-cli
* Repository URL: https://github.com/renehernandez/action-appfile
## Getting Started
Let's look at an example and see how `appfile` can help you to manage your App specification and deployments.
## Deploy a web service
This example deploys an App containing a service definition. The 2 environments: *review* and *production* will customize the final specification of the app to be deployed. Let's look at the `appfile.yaml`, `app.yaml` and environments definitions below.
```yaml
# appfile.yaml
environments:
review:
- ./envs/review.yaml
production:
- ./envs/production.yaml
specs:
- ./app.yaml
```
```yaml
# app.yaml
name: {{ .Values.name }}
services:
- name: web
github:
repo:
branch: main
deploy_on_push: {{ .Values.deploy_on_push }}
envs:
- key: WEBSITE_NAME
value: {{ requiredEnv "WEBSITE_NAME" }}
```
```yaml
# review.yaml
name: sample-review
deploy_on_push: true
```
```yaml
# production.yaml
name: sample-production
deploy_on_push: false
```
You can deploy your App in review by running:
```console
WEBSITE_NAME='Appfile Review' appfile sync --file /path/to/appfile.yaml --environment review
```
The final App spec to be synced to DigitalOcean would be:
```yaml
name: sample-review
services:
- name: web
github:
repo:
branch: main
deploy_on_push: true
routes:
- path: /
envs:
- key: WEBSITE_NAME
value: Appfile Review
```
Or you can deploy your App in production:
```console
WEBSITE_NAME='Appfile Prod' appfile sync --file /path/to/appfile.yaml --environment production
```
The final App spec to be synced to DigitalOcean would be:
```yaml
name: sample-production
services:
- name: web
github:
repo:
branch: main
deploy_on_push: false
routes:
- path: /
envs:
- key: WEBSITE_NAME
value: Appfile Prod
```
To learn more about `appfile`, check out the [docs](https://renehernandez.github.io/appfile)
## Contributing
Check out the [Contributing](docs/CONTRIBUTING.md) page.
## Changelog
For inspecting the changes and tag releases, check the [Changelog](CHANGELOG.md) page
## Appreciation
This project is inspired in [helmfile](https://github.com/roboll/helmfile), from which I have borrowed heavily for the first iteration.
## License
Check out the [LICENSE](LICENSE) for details.