{"id":17257704,"url":"https://github.com/jvalkeal/setup-cf-cli","last_synced_at":"2025-04-06T08:45:40.707Z","repository":{"id":40771977,"uuid":"260852250","full_name":"jvalkeal/setup-cf-cli","owner":"jvalkeal","description":"Github action to setup Cloudfoundry CLI","archived":false,"fork":false,"pushed_at":"2023-01-05T11:15:14.000Z","size":571,"stargazers_count":1,"open_issues_count":14,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-24T20:04:32.359Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jvalkeal.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-05-03T07:40:02.000Z","updated_at":"2023-03-22T03:35:23.000Z","dependencies_parsed_at":"2023-02-04T02:46:44.136Z","dependency_job_id":null,"html_url":"https://github.com/jvalkeal/setup-cf-cli","commit_stats":{"total_commits":26,"total_committers":1,"mean_commits":26.0,"dds":0.0,"last_synced_commit":"eb30a98aa3a9f44823dc49a523c6212980b59ee2"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jvalkeal%2Fsetup-cf-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jvalkeal%2Fsetup-cf-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jvalkeal%2Fsetup-cf-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jvalkeal%2Fsetup-cf-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jvalkeal","download_url":"https://codeload.github.com/jvalkeal/setup-cf-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247457742,"owners_count":20941906,"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":[],"created_at":"2024-10-15T07:18:18.722Z","updated_at":"2025-04-06T08:45:40.689Z","avatar_url":"https://github.com/jvalkeal.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# setup-cf-cli\n\n\u003cp align=\"left\"\u003e\n  \u003ca href=\"https://github.com/jvalkeal/setup-cf-cli\"\u003e\u003cimg alt=\"GitHub Actions status\" src=\"https://github.com/jvalkeal/setup-cf-cli/workflows/Main%20workflow/badge.svg\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nGitHub Action to install and setup a [Cloudfoundry CLI](https://github.com/cloudfoundry/cli)\nto get used with action workflows.\n\n# Usage\n\nSee [action.yml](action.yml)\n\n## Basic\n```yaml\nsteps:\n- uses: actions/checkout@v2\n- uses: jvalkeal/setup-cf-cli@v0\n  with:\n    version: 6.51.0 # The CLI version to make available on the path.\n```\n\n## Login\n\n**NOTE**\nNot yet release, available only from _main_.\n\nYou need to store environment settings in a GitHub secrets,\nGitHub will then make sure that none of these secrets are exposed\nto publicly visible logs.\n\nThere's an embedded functionality to run login command which is disabled\non default. It's expected that _api_, _org_, _space_, _username_ and\n_password_ are available as an environment variable. Below config\nshould default values.\n\n```yaml\nsteps:\n- name: Set up CF CLI\n  uses: jvalkeal/setup-cf-cli@v0\n  with:\n    version: 6.51.0\n    login: false\n    login-api: CF_API\n    login-org: CF_ORG\n    login-space: CF_SPACE\n    login-username: CF_USERNAME\n    login-password: CF_PASSWORD\n```\n\nBy just setting _login_ to _true_ would work nicely if env variables are\nmapped from secrects like this:\n\n```yaml\nenv:\n  CF_API: ${{ secrets.CF_API }}\n  CF_ORG: ${{ secrets.CF_ORG }}\n  CF_SPACE: ${{ secrets.CF_SPACE }}\n  CF_USERNAME: ${{ secrets.CF_USERNAME }}\n  CF_PASSWORD: ${{ secrets.CF_PASSWORD }}\n```\n\nIf a way actions does a login is not suitable, you can always do it\nmanually by doing something like:\n\n```yaml\nsteps:\n- name: Set up CF CLI\n  uses: jvalkeal/setup-cf-cli@v0\n  with:\n    version: 6.51.0\n- name: CF Login\n  run: cf login -a $CF_API -u $CF_USERNAME -o $CF_ORG -s $CF_SPACE -p $CF_PASSWORD\n  env:\n    CF_API: ${{ secrets.CF_API }}\n    CF_ORG: ${{ secrets.CF_ORG }}\n    CF_SPACE: ${{ secrets.CF_SPACE }}\n    CF_USERNAME: ${{ secrets.CF_USERNAME }}\n    CF_PASSWORD: ${{ secrets.CF_PASSWORD }}\n```\n\n\n## Plugins\n\n**NOTE**\nNot yet release, available only from _main_.\n\nIt's possible to install plugins by defining its existense with a plugin repository.\nIf you only need to install one plugin, use `plugin-repo` and `plugin-id`, otherwise\nif a need for multiple repos and plugins, define `plugins` which takes a json format.\n\n```yaml\nsteps:\n- uses: jvalkeal/setup-cf-cli@main\n  with:\n    plugins: |\n      [\n        {repo:\"https://plugins.cloudfoundry.org\", id:\"blue-green-deploy\"}\n      ]\n    plugin-repo: https://plugins.cloudfoundry.org\n    plugin-id: blue-green-deploy\n```\n\n# Versions\n\nVersions are released as a git tags. We're currenly on a pre-release stage so\ncurrent _0.x_ series can be found under tag _v0_ which will always be a same\nas latest within _0.x_ like _v0.0.1_.\n\n**NOTE:** While not recommended you can also use _main_ as a version which\nwould always have latest development version. Just remember that _main_\nmay not be stable.\n\n# License\n\nThe scripts and documentation in this project are released under the [MIT License](LICENSE)\n\n# Contributions\n\nContributions are welcome!  See [Contributor's Guide](docs/contributors.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjvalkeal%2Fsetup-cf-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjvalkeal%2Fsetup-cf-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjvalkeal%2Fsetup-cf-cli/lists"}