Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clowdhaus/argo-cd-action
GitHub action for executing Argo CD 🦑
https://github.com/clowdhaus/argo-cd-action
argo-cd argocd github-action gitops
Last synced: 3 months ago
JSON representation
GitHub action for executing Argo CD 🦑
- Host: GitHub
- URL: https://github.com/clowdhaus/argo-cd-action
- Owner: clowdhaus
- License: apache-2.0
- Created: 2021-02-11T02:40:35.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-23T11:47:44.000Z (6 months ago)
- Last Synced: 2024-07-20T21:42:06.191Z (4 months ago)
- Topics: argo-cd, argocd, github-action, gitops
- Language: TypeScript
- Homepage:
- Size: 1.54 MB
- Stars: 73
- Watchers: 3
- Forks: 14
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-argo - argo-cd-action
README
argo-cd-action
GitHub action for executing Argo CD 🦑
## Usage
See the [ArgoCD CLI documentation](https://argoproj.github.io/argo-cd/user-guide/commands/argocd/) for the list of available commands and options.
```yml
- uses: clowdhaus/argo-cd-action/@main
with:
version: 2.6.7
command: version
options: --client
```
### With GitHub API authentication
If you are running a lot of workflows/jobs quite frequently, you may run into GitHub's API rate limit due to pulling the CLI from the ArgoCD repository. To get around this limitation, add the `GITHUB_TOKEN` as shown below (or see [here](https://github.com/octokit/auth-action.js#createactionauth) for more examples) to utilize a higher rate limit when authenticated.
```yml
- uses: clowdhaus/argo-cd-action/@main
env:
# Only required for first step in job where API is called
# All subsequent setps in a job will not re-download the CLI
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
command: version
options: --client
- uses: clowdhaus/argo-cd-action/@main
# CLI has already been downloaded in prior step, no call to GitHub API
with:
command: version
options: --client
```
## Getting Started
The following instructions will help you get setup for development and testing purposes.
### Prerequisites
#### [yarn](https://github.com/yarnpkg/yarn)
`yarn` is used to handle dependencies and executing scripts on the codebase.
See [here](https://yarnpkg.com/en/docs/install#debian-stable) for instructions on installing yarn on your local machine.
Once you have installed `yarn`, you can install the project dependencies by running the following command from within the project root directory:
```bash
$ yarn
```
## Contributing
Please read [CODE_OF_CONDUCT.md](.github/CODE_OF_CONDUCT.md) for details on our code of conduct and the process for submitting pull requests.
## Changelog
Please see the [CHANGELOG.md](CHANGELOG.md) for details on individual releases.