https://github.com/wisersolutions/gitops-deploy
Commit to a GitHub repository with the latest version of your app to trigger a deployment (with ex. ArgoCD, Flux)
https://github.com/wisersolutions/gitops-deploy
Last synced: 10 months ago
JSON representation
Commit to a GitHub repository with the latest version of your app to trigger a deployment (with ex. ArgoCD, Flux)
- Host: GitHub
- URL: https://github.com/wisersolutions/gitops-deploy
- Owner: WiserSolutions
- Created: 2020-06-24T21:30:34.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-07-03T13:40:02.000Z (almost 2 years ago)
- Last Synced: 2025-07-29T16:40:21.044Z (11 months ago)
- Language: JavaScript
- Size: 495 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
GitOps Deploy for GitHub Actions
====
This repo provides a module to automatically update a version reference within a GitOps YAML repository. This can be combined with a GitOps compatible tools (such as [ArgoCD](https://argoproj.github.io/argo-cd/) or [Flux](https://fluxcd.io/)) to automatically deploy the latest app artifacts to your environments.
## Basic Usage
Add a step to your deployment workflow, after you have packaged your code (with Docker or otherwise):
```
- uses: WiserSolutioons/gitops-deploy@v1
with:
repository: /
ref: test/prod/whatever
path: kube/.yaml
token: ${{ secrets. }}
field: 0.image.tag # or whatever the yaml field is where you put the version of your app
new-version:
```
## Options Reference
| Name | Required | Description |
| ------------------------:|:--------:| ---------------------------------------------------------------- |
| `host` | no | SSH host of your GitOps repository |
| `repository` | yes | Path of your GitHub repo (ex. Org/repo-name) |
| `ref` | yes | Branch or Git identifier to commit on (including `refs/heads/`) |
| `token` | yes | Authentication for GitHub HTTP |
| `path` | yes | Path of the file which configures this service |
| `field` | yes | Location within the YAML to insert the new version/tag, in [lodash.set syntax](https://lodash.com/docs/4.17.15#set) |
| `new-version` | yes | String which should be set as the new version in the given field |
| `retryCount` | no | Number of times to retry if commit fails due to remote conflicts |