https://github.com/deliverybot/gitops
GitHub action for editing repos GitOps style.
https://github.com/deliverybot/gitops
Last synced: 11 months ago
JSON representation
GitHub action for editing repos GitOps style.
- Host: GitHub
- URL: https://github.com/deliverybot/gitops
- Owner: deliverybot
- License: mit
- Created: 2019-10-20T03:35:40.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-08-18T19:16:42.000Z (almost 4 years ago)
- Last Synced: 2023-03-02T22:56:40.801Z (over 3 years ago)
- Language: JavaScript
- Homepage: https://deliverybot.dev
- Size: 434 KB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitOps action
Writes a set of manifests to a GitOps style repository and commits the result.
**This is currently in beta and the API around this action may change.**
## Parameters
### Inputs
- `remote`: Remote gitops repository to clone and commit to. (required)
- `branch`: Remote gitops repository branch. (required)
- `manifests`: Manifests are a list of files (in json format) to copy to
target. (required)
- `target`: Folder name in the gitops repository to copy manifests to.
(required)
- `token`: Github repository token.
## Example
Note, in the example the `FLUX_KEY` is a deploy key that's allowed access to the
GitHub repository.
```yaml
# .github/workflows/gitops.yml
name: Deploy
on: ['deployment']
jobs:
deployment:
runs-on: 'ubuntu-latest'
steps:
- uses: actions/checkout@v1
- uses: webfactory/ssh-agent@v0.1.1
with:
ssh-private-key: ${{ secrets.FLUX_KEY }}
- name: 'gitops'
uses: 'deliverybot/gitops@master'
with:
remote: 'git@github.com:colinjfw/kubernetes-guide.git'
branch: 'master'
# Copy the "pod.yml" manifest over to...
manifests: '["pod.yml"]'
# ... the deploy folder in the remote specified.
target: 'deploy'
token: '${{ github.token }}'
```