argo-cd-action

GitHub action for executing Argo CD 🦑

Usage

See the ArgoCD CLI documentation for the list of available commands and options.

- 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 for more examples) to utilize a higher rate limit when authenticated.

- 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

yarn is used to handle dependencies and executing scripts on the codebase.

See here 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:

  $ yarn

Contributing

Please read CODE_OF_CONDUCT.md for details on our code of conduct and the process for submitting pull requests.

Changelog

Please see the CHANGELOG.md for details on individual releases.