Document process for creating new releases

README.md

@@ -30,14 +30,14 @@ jobs:
 
     - 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
@@ -66,20 +66,22 @@ By default this action uses the cf CLI v8 to take advantage of some of the [new
 
 ## Protecting secret values in attributes for the deployment
 
-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: 
+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:
 
-```
+```shell
 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](https://docs.cloudfoundry.org/buildpacks/php/gsg-php-newrelic.html). However if you do not mask the environment variable as part of the deployment, subsequent deploys will show the license in the diff. 
+**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](https://docs.cloudfoundry.org/buildpacks/php/gsg-php-newrelic.html). However if you do not mask the environment variable as part of the deployment, subsequent deploys will show the license in the diff.
 
 ## Other options
 
 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.
 
-- <https://github.com/18F/cg-deploy-action>
 - <https://github.com/usds/cloud-gov-cli>
-- <https://github.com/alphagov/paas-docker-cloudfoundry-tools>
 - <https://hub.docker.com/r/governmentpaas/cf-cli>
 - <https://registry.terraform.io/providers/cloudfoundry-community/cloudfoundry/latest/docs>
+
+## Creating a new release
+
+See [RELEASE.md](./RELEASE.md).

RELEASE.md

@@ -0,0 +1,16 @@
+# Releasing
+
+Here's how to issue a new release:
+
+1. Create a tag for the new release and push it to GitHub. For instance, if you're
+   releasing v1.0.4, do:
+
+   ```shell
+   git tag -a v1.0.4
+   git push origin v1.0.4
+   ```
+
+   When running `git tag`, you'll be prompted for a tag
+   message.
+
+1. [Create a release for the tag in GitHub](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release).