A Github action for using CF CLI tools while deploying and managing apps on cloud.gov.
Follow the instructions for setting up a cloud.gov service account. Store you username (CG_USERNAME) and password (CG_PASSWORD) as encrypted secrets.
The following is an example of a workflow that uses this action. This example shows how to deploy a simple .NET Core app to cloud.gov
name: .NET Core Deploy
on:
pull_request:
branches: [ {branch-name} ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Setup .NET Core
uses: actions/setup-dotnet@v1
with:
dotnet-version: 3.1.101
- name: Install dependencies
run: dotnet restore
- name: Build
run: dotnet build
deploy:
runs-on: ubuntu-latest
needs: build
steps:
- uses: actions/checkout@v2
- name: Deploy to cloud.gov
uses: cloud-gov/cg-cli-tools@main
with:
cf_username: ${{ secrets.CG_USERNAME }}
cf_password: ${{ secrets.CG_PASSWORD }}
cf_org: your-org
cf_space: your-space
The default action is to do a cf push -f manifest.yml --strategy rolling.
You can also supply:
cf_api:to specify a Cloud Foundry API endpoint (instead of the defaultapi.fr.cloud.gov)cf_manifest:to use a different manifest file (instead of the defaultmanifest.yml)cf_vars_file:to specify values for variables in the manifest filecf_command:to specify a CF sub-command to run (instead of the defaultpush -f $MANIFEST -vars-file $VARS_FILE --strategy rolling)command:to specify another command altogether (for example: a script which checks if required services are present and creates them if they're missing)
By default this action uses the cf CLI v8 to take advantage of some of the new features in that version. If you need to use v7 of the CLI, you can target the cli-v7 branch when setting up your workflow, like so: cloud-gov/cg-cli-tools@cli-v7
If you have secret values in the attributes (environment variables) of the deployment that should remain secret, it is best to use the --var flag with cf push in this action so that you can pass a Github secret to the command, which will automatically mask the variable in the deployment logs. Use cf_command like so:
cf_command: "push -f <MANIFEST> --var var-name=${{ secrets.SECRET_VAR_VALUE }} --strategy rolling"
Example: For the PHP Buildpack, if you want to use New Relic, all you have to do is provide the license as an environment variable. However if you do not mask the environment variable as part of the deployment, subsequent deploys will show the license in the diff.
There are other tools and utilities that you can use to deploy your application to cloud.gov. Here is a list of some of the more common options.