{"id":13821628,"url":"https://github.com/fluxcd/fluxctl-action","last_synced_at":"2025-05-16T12:33:57.547Z","repository":{"id":56251364,"uuid":"250769365","full_name":"fluxcd/fluxctl-action","owner":"fluxcd","description":"A GitHub Action to run fluxctl commands","archived":true,"fork":false,"pushed_at":"2020-11-18T13:13:57.000Z","size":14,"stargazers_count":15,"open_issues_count":1,"forks_count":6,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-02-14T19:48:38.408Z","etag":null,"topics":["github-actions","gitops"],"latest_commit_sha":null,"homepage":"https://docs.fluxcd.io/en/latest/references/fluxctl/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fluxcd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-28T10:46:10.000Z","updated_at":"2023-02-28T21:50:01.000Z","dependencies_parsed_at":"2023-01-04T21:31:08.763Z","dependency_job_id":null,"html_url":"https://github.com/fluxcd/fluxctl-action","commit_stats":{"total_commits":10,"total_committers":1,"mean_commits":10.0,"dds":0.0,"last_synced_commit":"a5e16eadcf4db7bb4c35b169b8e63f6621d10061"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluxcd%2Ffluxctl-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluxcd%2Ffluxctl-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluxcd%2Ffluxctl-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluxcd%2Ffluxctl-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fluxcd","download_url":"https://codeload.github.com/fluxcd/fluxctl-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254530943,"owners_count":22086696,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-actions","gitops"],"created_at":"2024-08-04T08:01:24.993Z","updated_at":"2025-05-16T12:33:57.236Z","avatar_url":"https://github.com/fluxcd.png","language":"Shell","funding_links":[],"categories":["others"],"sub_categories":[],"readme":"# fluxctl-action\n\n[![e2e](https://github.com/fluxcd/fluxctl-action/workflows/e2e/badge.svg)](https://github.com/fluxcd/fluxctl-action/actions)\n\nA GitHub Action to run fluxctl [commands](https://docs.fluxcd.io/en/latest/references/fluxctl/).\n\n## Usage\n\nIn order to use fluxctl in GitHub Actions you have to install kubectl on the GitHub Action runner and\nsetup the current context to a Kubernetes cluster where Flux is running.\n\n```yaml\nname: Synchronize cluster\n\non: push\n\njobs:\n  fluxctl:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: azure/setup-kubectl@v1\n      - uses: azure/k8s-set-context@v1\n        with:\n          method: kubeconfig\n          kubeconfig: \u003cyour kubeconfig\u003e\n      - name: Setup fluxctl\n        uses: fluxcd/fluxctl-action@master\n      - name: Synchronize cluster\n        env:\n          FLUX_FORWARD_NAMESPACE: flux\n        run: fluxctl sync\n```\n\n## Kubernetes Kind\n\nYou can use the fluxctl GitHub Action together with Kubernetes Kind to build an end-to-end testing pipeline \nfor the git repository that defines your cluster desired state.\n\n```yaml\nname: e2e\n\non: push\n\njobs:\n  fluxctl:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v2\n      - name: Setup Kubernetes\n        uses: engineerd/setup-kind@v0.3.0\n      - name: Setup fluxctl\n        uses: fluxcd/fluxctl-action@master\n      - name: Install Flux\n        run: |\n          kubectl create ns flux\n          fluxctl install \\\n          --git-path=test \\\n          --git-branch=${GITHUB_REF#refs/heads/} \\\n          --git-readonly=true \\\n          --registry-disable-scanning=true \\\n          --git-email=fluxcdbot@users.noreply.github.com \\\n          --git-url=https://github.com/fluxcd/fluxctl-action.git \\\n          --namespace=flux | kubectl apply -f -\n      - name: Verify install\n        run: kubectl -n flux rollout status deploy/flux --timeout=1m\n      - name: Sync git with cluster\n        env:\n          FLUX_FORWARD_NAMESPACE: flux\n        run: fluxctl sync\n      - name: Verify sync\n        run: kubectl get ns | grep test\n```\n\nNote that we set `--git-branch=${GITHUB_REF#refs/heads/}` so that Flux will sync the current branch. \n\nIf the git repository is not public, then you have to configure Flux with a\n[personal access token](https://docs.fluxcd.io/en/latest/guides/use-git-https/)\nso that it can synchronize the repo over HTTPS.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffluxcd%2Ffluxctl-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffluxcd%2Ffluxctl-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffluxcd%2Ffluxctl-action/lists"}