From bf72a2f486f950d3c6b1be566f8717f998bbce51 Mon Sep 17 00:00:00 2001 From: AkhileshNS Date: Sat, 26 Dec 2020 22:08:48 +0530 Subject: [PATCH] Bumped ver number --- README.md | 72 +++++++++++++++++++++++++++---------------------------- 1 file changed, 36 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 9e27130..60ff912 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.8.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 @@ -65,27 +65,27 @@ 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 | -| team | false | If deploying to an organization, then specify the name of the team or organization here | team-xyz | +| 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 | +| team | false | If deploying to an organization, then specify the name of the team or organization here | team-xyz | ## Examples @@ -108,7 +108,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.8.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 @@ -135,7 +135,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.8.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 @@ -174,7 +174,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.8.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 @@ -201,7 +201,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.8.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 @@ -230,7 +230,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.8.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 @@ -259,7 +259,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.8.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 @@ -290,7 +290,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.8.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 @@ -320,7 +320,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.8.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 @@ -350,7 +350,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.8.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 @@ -383,7 +383,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.8.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 @@ -418,7 +418,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.8.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 @@ -465,7 +465,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.8.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 @@ -494,10 +494,10 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.8.8-beta + - uses: akhileshns/heroku-deploy@v3.8.8 with: heroku_api_key: ${{secrets.HEROKU_API_KEY}} - heroku_app_name: "YOUR APP's NAME" + heroku_app_name: "YOUR APP's NAME" heroku_email: "YOUR EMAIL" team: "THE TEAM's NAME" ``` @@ -521,7 +521,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: akhileshns/heroku-deploy@v3.7.8 # This is the action + - uses: akhileshns/heroku-deploy@v3.8.8 # This is the action with: heroku_api_key: ${{secrets.HEROKU_API_KEY}} heroku_app_name: ""