From 7a09db9c4e101a49fe1bef554a60d0447fe1cc51 Mon Sep 17 00:00:00 2001 From: AkhileshNS Date: Thu, 10 Dec 2020 01:00:40 +0530 Subject: [PATCH] Updated version --- README.md | 74 +++++++++++++++++++++++++++---------------------------- 1 file changed, 37 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 6b4312c..211a7ca 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,9 @@ This is a very simple GitHub action that allows you to deploy to Heroku. The act - [Deploy Subdirectory](#deploy-subdirectory) - [Deploy Custom Branch](#deploy-custom-branch) 4. [Health Check](#health-check) - - [Advanced Usage](#advanced-usage) - - [Adding Delay](#adding-delay) - - [Rollback on healthcheck failure](#rollback-on-healthcheck-failure) + - [Advanced Usage](#advanced-usage) + - [Adding Delay](#adding-delay) + - [Rollback on healthcheck failure](#rollback-on-healthcheck-failure) 5. [Environment Variables](#environment-variables) - [ENV File](#env-file) 6. [Procfile Passing](#procfile-passing) @@ -45,7 +45,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.6.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action with: heroku_api_key: ${{secrets.HEROKU_API_KEY}} heroku_app_name: "YOUR APP's NAME" #Must be unique in Heroku @@ -64,26 +64,26 @@ You learn more about GitHub Secrets [here](https://docs.github.com/en/actions/co The action comes with additional options that you can use to configure your project's behavior on Heroku. You can setup these options under the "with" object as presented above: -| Name | Required | Description | Example | -| --------------------------- | -------- | ------------------------------------------------------------ | ----------------------------------------------------- | -| heroku_api_key | true | This will be used for authentication. You can find it in your heroku homepage account settings | \*\*\* | -| heroku_email | true | Email that you use with heroku | nsakhilesh02@gmail.com | -| heroku_app_name | true | The appname to use for deploying/updating | demo-rest-api | -| buildpack | false | An optional buildpack to use when creating the heroku application | https://github.com/heroku/heroku-buildpack-static.git | -| branch | false | The branch that you would like to deploy to Heroku. Defaults to "HEAD" | master, dev, test | -| dontuseforce | false | Set this to true if you don't want to use --force when switching branches | true or false | -| usedocker | false | Will deploy using Dockerfile in project root | true or false | +| Name | Required | Description | Example | +| --------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | +| heroku_api_key | true | This will be used for authentication. You can find it in your heroku homepage account settings | \*\*\* | +| heroku_email | true | Email that you use with heroku | nsakhilesh02@gmail.com | +| heroku_app_name | true | The appname to use for deploying/updating | demo-rest-api | +| buildpack | false | An optional buildpack to use when creating the heroku application | https://github.com/heroku/heroku-buildpack-static.git | +| branch | false | The branch that you would like to deploy to Heroku. Defaults to "HEAD" | master, dev, test | +| dontuseforce | false | Set this to true if you don't want to use --force when switching branches | true or false | +| usedocker | false | Will deploy using Dockerfile in project root | true or false | | docker_heroku_process_type | false | Type of heroku process (web, worker, etc). This option only makes sense when usedocker enabled. Defaults to "web" (Thanks to [singleton11](https://github.com/singleton11) for adding this feature) | web, worker | -| docker_build_args | false | A list of args to pass into the Docker build. This option only makes sense when usedocker enabled. | NODE_ENV | -| appdir | false | Set if your app is located in a subdirectory | api, apis/python | -| healthcheck | false | A URL to which a healthcheck is performed (checks for 200 request) | https://demo-rest-api.herokuapp.com | -| checkstring | false | Value to check for when conducting healthcheck requests | ok | -| delay | false | Time (in seconds) to wait before performing healthcheck. Defaults to 0 seconds | 5 | -| procfile | false | Contents of the Procfile to save and deploy | web: npm start | -| rollbackonhealthcheckfailed | false | When set to true this will attempt to rollback to the previous release if the healthcheck fails | true or false | -| env_file | false | path to an env file (with respect to appdir) | /.env | -| justlogin | false | Set to true if you want the action to just login to Heroku and nothing else | true or false | -| region | false | The region in which you would like to deploy a server | eu or dublin | +| docker_build_args | false | A list of args to pass into the Docker build. This option only makes sense when usedocker enabled. | NODE_ENV | +| appdir | false | Set if your app is located in a subdirectory | api, apis/python | +| healthcheck | false | A URL to which a healthcheck is performed (checks for 200 request) | https://demo-rest-api.herokuapp.com | +| checkstring | false | Value to check for when conducting healthcheck requests | ok | +| delay | false | Time (in seconds) to wait before performing healthcheck. Defaults to 0 seconds | 5 | +| procfile | false | Contents of the Procfile to save and deploy | web: npm start | +| rollbackonhealthcheckfailed | false | When set to true this will attempt to rollback to the previous release if the healthcheck fails | true or false | +| env_file | false | path to an env file (with respect to appdir) | /.env | +| justlogin | false | Set to true if you want the action to just login to Heroku and nothing else | true or false | +| region | false | The region in which you would like to deploy a server | eu or dublin | ## Examples @@ -106,7 +106,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.6.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action with: heroku_api_key: ${{secrets.HEROKU_API_KEY}} heroku_app_name: "YOUR APP's NAME" #Must be unique in Heroku @@ -133,7 +133,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.6.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action with: heroku_api_key: ${{secrets.HEROKU_API_KEY}} heroku_app_name: "YOUR APP's NAME" #Must be unique in Heroku @@ -172,7 +172,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.6.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action with: heroku_api_key: ${{secrets.HEROKU_API_KEY}} heroku_app_name: "YOUR APP's NAME" #Must be unique in Heroku @@ -199,7 +199,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.6.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action with: heroku_api_key: ${{secrets.HEROKU_API_KEY}} heroku_app_name: "YOUR APP's NAME" #Must be unique in Heroku @@ -228,7 +228,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.6.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action with: heroku_api_key: ${{secrets.HEROKU_API_KEY}} heroku_app_name: "YOUR APP's NAME" #Must be unique in Heroku @@ -257,7 +257,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.6.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action with: heroku_api_key: ${{secrets.HEROKU_API_KEY}} heroku_app_name: "YOUR APP's NAME" #Must be unique in Heroku @@ -288,7 +288,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.6.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action with: heroku_api_key: ${{secrets.HEROKU_API_KEY}} heroku_app_name: "YOUR APP's NAME" #Must be unique in Heroku @@ -318,7 +318,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.6.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action with: heroku_api_key: ${{secrets.HEROKU_API_KEY}} heroku_app_name: "YOUR APP's NAME" #Must be unique in Heroku @@ -348,7 +348,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.6.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action with: heroku_api_key: ${{secrets.HEROKU_API_KEY}} heroku_app_name: "YOUR APP's NAME" #Must be unique in Heroku @@ -381,7 +381,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.6.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action with: heroku_api_key: ${{secrets.HEROKU_API_KEY}} heroku_app_name: "YOUR APP's NAME" #Must be unique in Heroku @@ -416,7 +416,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.6.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action with: heroku_api_key: ${{secrets.HEROKU_API_KEY}} heroku_app_name: "YOUR APP's NAME" #Must be unique in Heroku @@ -463,7 +463,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.6.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action with: heroku_api_key: ${{secrets.HEROKU_API_KEY}} heroku_app_name: "YOUR APP's NAME" #Must be unique in Heroku @@ -492,10 +492,10 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.6.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action with: heroku_api_key: ${{secrets.HEROKU_API_KEY}} - heroku_app_name: "" + heroku_app_name: "" heroku_email: "YOUR EMAIL" justlogin: true - run: heroku auth:whoami