@toptal/davinci-workflow 1.9.0 → 1.9.1-alpha-chore-implement-documentation-buid.10

package/README.md

@@ -18,38 +18,1642 @@ or
 
 Arguments:
 
-- `workflow-name` - the name of the GH workflow to create
+*   `workflow-name` - the name of the GH workflow to create
 
 ## GH Workflows
 
-- `typecheck` — Check an App on Typescript issues. Example: `davinci new-workflow typecheck`
-- `lint` — Check app for Lint issues. Example: `davinci new-workflow lint`
-- `unit-tests` — Conduct Unit tests. Example: `davinci new-workflow unit-tests`
-- `danger` - Run check on PR title and commit messages for compliance. Example `davinci new-workflow danger`
-- `alpha-package` - Execute script to publish alpha version of package to NPM. Example `davinci new-workflow alpha-package`
-  Example of usage in PR: write a new comment in PR
-  `@toptal-bot run package:alpha-release` — it runs [build-publish-alpha-package](https://github.com/toptal/davinci-github-actions/tree/master/build-publish-alpha-package) GH Action.
-- `deploy-temploy` - Builds & Deploys application to Temploy. It creates a new instance of Docker image, pushes it to cloud and triggers an appropriate Jenkins job to deploy the image to temploy.
-  Example of usage in PR: write a new comment in PR: `@toptal-bot run temploy`
-- `deploy` — Performs docker image build and deployment to staging/production environment. Consists of three Workflows:
-  - `Deploy` (davinci-deploy.yml)
-    - it's triggered when PR is merged to `master` or `main` branch
-    - It builds and pushes a new instance of Docker image to google cloud
-    - if `davinci.yml` is present in the root folder:
-      - and `deploy_staging` key is set to **true** then triggers `Deploy to Staging` GH Workflow
-      - and `deploy` key is set to **true** then triggers `Deploy to Production` GH Workflow
-  - `Deploy to staging` (davinci-deploy-staging.yml)
-    - Triggers Jenkins job for deployment to staging environment
-    - how to trigger the Workflow manually:
-      - add a new comment: `@toptal-bot run deploy-staging` in a PR. It will trigger a new GH Workflow. The latest commit in the PR branch will be taken to build a docker image.
-      - In the `actions` tab, choose `Deploy to Staging` GH Workflow and provide a commit SHA
-  - `Deploy to production` (davinci-deploy-production.yml)
-    - Triggers Jenkins job for deployment to production environment
-    - how to trigger the Workflow manually:
-      - In the `actions` tab, choose `Deploy to Production` GH Workflow and provide a commit SHA
-  - Find out more about how deployment works in [confluence](https://toptal-core.atlassian.net/l/c/ZN2K1f0r)
-  
+## alpha-package
+Executes script to publish alpha version of package to NPM
+
+**Example:**
+```bash
+$ davinci new-workflow alpha-package
+```
+**Description:**
+
+it triggers [build-publish-alpha-package](https://github.com/toptal/davinci-github-actions/tree/master/build-publish-alpha-package) GH Action.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run package:alpha-release`
+
+## typecheck
+Checks an App on Typescript issues
+
+**Example:**
+```bash
+$ davinci new-workflow typecheck
+```
+**Description:**
+
+it triggers `typecheck` GH Action
+
+
+
+## lint
+Checks an App for lint issues
+
+**Example:**
+```bash
+$ davinci new-workflow lint
+```
+**Description:**
+
+it triggers `lint` GH Action
+
+
+
+## unit-tests
+Conducts unit tests
+
+**Example:**
+```bash
+$ davinci new-workflow unit-tests
+```
+**Description:**
+
+it triggers `unit-tests` GH Action
+
+
+
+## integration-tests
+Conducts integration tests in a project using Cypress.
+
+**Example:**
+```bash
+$ davinci new-workflow integration-tests
+```
+**Description:**
+
+it triggers `integration-tests` GH Action
+
+
+
+## danger
+Checks if the PR title and commit messages comply with Toptal's standards
+
+**Example:**
+```bash
+$ davinci new-workflow danger
+```
+**Description:**
+
+it triggers `danger` GH Action
+
+
+
+## deploy-temploy
+Builds & Deploys application to Temploy
+
+**Example:**
+```bash
+$ davinci new-workflow deploy-temploy
+```
+**Description:**
+
+it creates a new instance of Docker image, pushes it to cloud and triggers an appropriate Jenkins job to deploy the image to temploy.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run temploy`
+
+## deploy
+Performs docker image build and deployment to staging/production environment
+
+**Example:**
+```bash
+$ davinci new-workflow deploy
+```
+**Description:**
+
+performs docker image build and deployment to staging/production environment. Consists of three Workflows:
+
+*   `Deploy` (davinci-deploy.yml)
+    *   it's triggered when PR is merged to `master` or `main` branch
+    *   It builds and pushes a new instance of Docker image to google cloud
+    *   if `davinci.yml` is present in the root folder:
+        *   and `deploy_staging` key is set to **true** then triggers `Deploy to Staging` GH Workflow
+        *   and `deploy` key is set to **true** then triggers `Deploy to Production` GH Workflow
+*   `Deploy to staging` (davinci-deploy-staging.yml)
+    *   Triggers Jenkins job for deployment to staging environment
+    *   how to trigger the Workflow manually:
+        *   add a new comment: `@toptal-bot run deploy-staging` in a PR. It will trigger a new GH Workflow. The latest commit in the PR branch will be taken to build a docker image.
+        *   In the `actions` tab, choose `Deploy to Staging` GH Workflow and provide a commit SHA
+*   `Deploy to production` (davinci-deploy-production.yml)
+    *   Triggers Jenkins job for deployment to production environment
+    *   how to trigger the Workflow manually:
+        *   In the `actions` tab, choose `Deploy to Production` GH Workflow and provide a commit SHA
+*   Find out more about how deployment works in [confluence](https://toptal-core.atlassian.net/l/c/ZN2K1f0r)
+
+
+
+## alpha-package
+
+Executes script to publish alpha version of package to NPM
+
+**Example:**
+
+```bash
+$ davinci new-workflow alpha-package
+```
+
+**Description:**
+
+it triggers [build-publish-alpha-package](https://github.com/toptal/davinci-github-actions/tree/master/build-publish-alpha-package) GH Action.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run package:alpha-release`
+
+## typecheck
+
+Checks an App on Typescript issues
+
+**Example:**
+
+```bash
+$ davinci new-workflow typecheck
+```
+
+**Description:**
+
+it triggers `typecheck` GH Action
+
+## lint
+
+Checks an App for lint issues
+
+**Example:**
+
+```bash
+$ davinci new-workflow lint
+```
+
+**Description:**
+
+it triggers `lint` GH Action
+
+## unit-tests
+
+Conducts unit tests
+
+**Example:**
+
+```bash
+$ davinci new-workflow unit-tests
+```
+
+**Description:**
+
+it triggers `unit-tests` GH Action
+
+## integration-tests
+
+Conducts integration tests in a project using Cypress.
+
+**Example:**
+
+```bash
+$ davinci new-workflow integration-tests
+```
+
+**Description:**
+
+it triggers `integration-tests` GH Action
+
+## danger
+
+Checks if the PR title and commit messages comply with Toptal's standards
+
+**Example:**
+
+```bash
+$ davinci new-workflow danger
+```
+
+**Description:**
+
+it triggers `danger` GH Action
+
+## deploy-temploy
+
+Builds & Deploys application to Temploy
+
+**Example:**
+
+```bash
+$ davinci new-workflow deploy-temploy
+```
+
+**Description:**
+
+it creates a new instance of Docker image, pushes it to cloud and triggers an appropriate Jenkins job to deploy the image to temploy.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run temploy`
+
+## deploy
+
+Performs docker image build and deployment to staging/production environment
+
+**Example:**
+
+```bash
+$ davinci new-workflow deploy
+```
+
+**Description:**
+
+performs docker image build and deployment to staging/production environment. Consists of three Workflows:
+
+*   `Deploy` (davinci-deploy.yml)
+    *   it's triggered when PR is merged to `master` or `main` branch
+    *   It builds and pushes a new instance of Docker image to google cloud
+    *   if `davinci.yml` is present in the root folder:
+        *   and `deploy_staging` key is set to **true** then triggers `Deploy to Staging` GH Workflow
+        *   and `deploy` key is set to **true** then triggers `Deploy to Production` GH Workflow
+*   `Deploy to staging` (davinci-deploy-staging.yml)
+    *   Triggers Jenkins job for deployment to staging environment
+    *   how to trigger the Workflow manually:
+        *   add a new comment: `@toptal-bot run deploy-staging` in a PR. It will trigger a new GH Workflow. The latest commit in the PR branch will be taken to build a docker image.
+        *   In the `actions` tab, choose `Deploy to Staging` GH Workflow and provide a commit SHA
+*   `Deploy to production` (davinci-deploy-production.yml)
+    *   Triggers Jenkins job for deployment to production environment
+    *   how to trigger the Workflow manually:
+        *   In the `actions` tab, choose `Deploy to Production` GH Workflow and provide a commit SHA
+*   Find out more about how deployment works in [confluence](https://toptal-core.atlassian.net/l/c/ZN2K1f0r)
+
+## alpha-package
+
+Executes script to publish alpha version of package to NPM!
+
+**Example:**
+
+```bash
+$ davinci new-workflow alpha-package
+```
+
+**Description:**
+
+it triggers [build-publish-alpha-package](https://github.com/toptal/davinci-github-actions/tree/master/build-publish-alpha-package) GH Action.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run package:alpha-release`
+
+## typecheck
+
+Checks an App on Typescript issues
+
+**Example:**
+
+```bash
+$ davinci new-workflow typecheck
+```
+
+**Description:**
+
+it triggers `typecheck` GH Action
+
+## lint
+
+Checks an App for lint issues
+
+**Example:**
+
+```bash
+$ davinci new-workflow lint
+```
+
+**Description:**
+
+it triggers `lint` GH Action
+
+## unit-tests
+
+Conducts unit tests
+
+**Example:**
+
+```bash
+$ davinci new-workflow unit-tests
+```
+
+**Description:**
+
+it triggers `unit-tests` GH Action
+
+## integration-tests
+
+Conducts integration tests in a project using Cypress.
+
+**Example:**
+
+```bash
+$ davinci new-workflow integration-tests
+```
+
+**Description:**
+
+it triggers `integration-tests` GH Action
+
+## danger
+
+Checks if the PR title and commit messages comply with Toptal's standards
+
+**Example:**
+
+```bash
+$ davinci new-workflow danger
+```
+
+**Description:**
+
+it triggers `danger` GH Action
+
+## deploy-temploy
+
+Builds & Deploys application to Temploy
+
+**Example:**
+
+```bash
+$ davinci new-workflow deploy-temploy
+```
+
+**Description:**
+
+it creates a new instance of Docker image, pushes it to cloud and triggers an appropriate Jenkins job to deploy the image to temploy.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run temploy`
+
+## deploy
+
+Performs docker image build and deployment to staging/production environment
+
+**Example:**
+
+```bash
+$ davinci new-workflow deploy
+```
+
+**Description:**
+
+performs docker image build and deployment to staging/production environment. Consists of three Workflows:
+
+*   `Deploy` (davinci-deploy.yml)
+    *   it's triggered when PR is merged to `master` or `main` branch
+    *   It builds and pushes a new instance of Docker image to google cloud
+    *   if `davinci.yml` is present in the root folder:
+        *   and `deploy_staging` key is set to **true** then triggers `Deploy to Staging` GH Workflow
+        *   and `deploy` key is set to **true** then triggers `Deploy to Production` GH Workflow
+*   `Deploy to staging` (davinci-deploy-staging.yml)
+    *   Triggers Jenkins job for deployment to staging environment
+    *   how to trigger the Workflow manually:
+        *   add a new comment: `@toptal-bot run deploy-staging` in a PR. It will trigger a new GH Workflow. The latest commit in the PR branch will be taken to build a docker image.
+        *   In the `actions` tab, choose `Deploy to Staging` GH Workflow and provide a commit SHA
+*   `Deploy to production` (davinci-deploy-production.yml)
+    *   Triggers Jenkins job for deployment to production environment
+    *   how to trigger the Workflow manually:
+        *   In the `actions` tab, choose `Deploy to Production` GH Workflow and provide a commit SHA
+*   Find out more about how deployment works in [confluence](https://toptal-core.atlassian.net/l/c/ZN2K1f0r)
+
+## alpha-package
+
+Executes script to publish alpha version of package to NPM
+
+**Example:**
+
+```bash
+$ davinci new-workflow alpha-package
+```
+
+**Description:**
+
+it triggers [build-publish-alpha-package](https://github.com/toptal/davinci-github-actions/tree/master/build-publish-alpha-package) GH Action.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run package:alpha-release`
+
+## typecheck
+
+Checks an App on Typescript issues
+
+**Example:**
+
+```bash
+$ davinci new-workflow typecheck
+```
+
+**Description:**
+
+it triggers `typecheck` GH Action
+
+## lint
+
+Checks an App for lint issues
+
+**Example:**
+
+```bash
+$ davinci new-workflow lint
+```
+
+**Description:**
+
+it triggers `lint` GH Action
+
+## unit-tests
+
+Conducts unit tests
+
+**Example:**
+
+```bash
+$ davinci new-workflow unit-tests
+```
+
+**Description:**
+
+it triggers `unit-tests` GH Action
+
+## integration-tests
+
+Conducts integration tests in a project using Cypress.
+
+**Example:**
+
+```bash
+$ davinci new-workflow integration-tests
+```
+
+**Description:**
+
+it triggers `integration-tests` GH Action
+
+## danger
+
+Checks if the PR title and commit messages comply with Toptal's standards
+
+**Example:**
+
+```bash
+$ davinci new-workflow danger
+```
+
+**Description:**
+
+it triggers `danger` GH Action
+
+## deploy-temploy
+
+Builds & Deploys application to Temploy
+
+**Example:**
+
+```bash
+$ davinci new-workflow deploy-temploy
+```
+
+**Description:**
+
+it creates a new instance of Docker image, pushes it to cloud and triggers an appropriate Jenkins job to deploy the image to temploy.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run temploy`
+
+## deploy
+
+Performs docker image build and deployment to staging/production environment
+
+**Example:**
+
+```bash
+$ davinci new-workflow deploy
+```
+
+**Description:**
+
+performs docker image build and deployment to staging/production environment. Consists of three Workflows:
+
+*   `Deploy` (davinci-deploy.yml)
+    *   it's triggered when PR is merged to `master` or `main` branch
+    *   It builds and pushes a new instance of Docker image to google cloud
+    *   if `davinci.yml` is present in the root folder:
+        *   and `deploy_staging` key is set to **true** then triggers `Deploy to Staging` GH Workflow
+        *   and `deploy` key is set to **true** then triggers `Deploy to Production` GH Workflow
+*   `Deploy to staging` (davinci-deploy-staging.yml)
+    *   Triggers Jenkins job for deployment to staging environment
+    *   how to trigger the Workflow manually:
+        *   add a new comment: `@toptal-bot run deploy-staging` in a PR. It will trigger a new GH Workflow. The latest commit in the PR branch will be taken to build a docker image.
+        *   In the `actions` tab, choose `Deploy to Staging` GH Workflow and provide a commit SHA
+*   `Deploy to production` (davinci-deploy-production.yml)
+    *   Triggers Jenkins job for deployment to production environment
+    *   how to trigger the Workflow manually:
+        *   In the `actions` tab, choose `Deploy to Production` GH Workflow and provide a commit SHA
+*   Find out more about how deployment works in [confluence](https://toptal-core.atlassian.net/l/c/ZN2K1f0r)
+
+## alpha-package
+
+Executes script to publish alpha version of package to NPM--
+
+**Example:**
+
+```bash
+$ davinci new-workflow alpha-package
+```
+
+**Description:**
+
+it triggers [build-publish-alpha-package](https://github.com/toptal/davinci-github-actions/tree/master/build-publish-alpha-package) GH Action.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run package:alpha-release`
+
+## typecheck
+
+Checks an App on Typescript issues
+
+**Example:**
+
+```bash
+$ davinci new-workflow typecheck
+```
+
+**Description:**
+
+it triggers `typecheck` GH Action
+
+## lint
+
+Checks an App for lint issues
+
+**Example:**
+
+```bash
+$ davinci new-workflow lint
+```
+
+**Description:**
+
+it triggers `lint` GH Action
+
+## unit-tests
+
+Conducts unit tests
+
+**Example:**
+
+```bash
+$ davinci new-workflow unit-tests
+```
+
+**Description:**
+
+it triggers `unit-tests` GH Action
+
+## integration-tests
+
+Conducts integration tests in a project using Cypress.
+
+**Example:**
+
+```bash
+$ davinci new-workflow integration-tests
+```
+
+**Description:**
+
+it triggers `integration-tests` GH Action
+
+## danger
+
+Checks if the PR title and commit messages comply with Toptal's standards
+
+**Example:**
+
+```bash
+$ davinci new-workflow danger
+```
+
+**Description:**
+
+it triggers `danger` GH Action
+
+## deploy-temploy
+
+Builds & Deploys application to Temploy
+
+**Example:**
+
+```bash
+$ davinci new-workflow deploy-temploy
+```
+
+**Description:**
+
+it creates a new instance of Docker image, pushes it to cloud and triggers an appropriate Jenkins job to deploy the image to temploy.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run temploy`
+
+## deploy
+
+Performs docker image build and deployment to staging/production environment
+
+**Example:**
+
+```bash
+$ davinci new-workflow deploy
+```
+
+**Description:**
+
+performs docker image build and deployment to staging/production environment. Consists of three Workflows:
+
+*   `Deploy` (davinci-deploy.yml)
+    *   it's triggered when PR is merged to `master` or `main` branch
+    *   It builds and pushes a new instance of Docker image to google cloud
+    *   if `davinci.yml` is present in the root folder:
+        *   and `deploy_staging` key is set to **true** then triggers `Deploy to Staging` GH Workflow
+        *   and `deploy` key is set to **true** then triggers `Deploy to Production` GH Workflow
+*   `Deploy to staging` (davinci-deploy-staging.yml)
+    *   Triggers Jenkins job for deployment to staging environment
+    *   how to trigger the Workflow manually:
+        *   add a new comment: `@toptal-bot run deploy-staging` in a PR. It will trigger a new GH Workflow. The latest commit in the PR branch will be taken to build a docker image.
+        *   In the `actions` tab, choose `Deploy to Staging` GH Workflow and provide a commit SHA
+*   `Deploy to production` (davinci-deploy-production.yml)
+    *   Triggers Jenkins job for deployment to production environment
+    *   how to trigger the Workflow manually:
+        *   In the `actions` tab, choose `Deploy to Production` GH Workflow and provide a commit SHA
+*   Find out more about how deployment works in [confluence](https://toptal-core.atlassian.net/l/c/ZN2K1f0r)
+
+## alpha-package
+
+Executes script to publish alpha version of package to NPM--
+
+**Example:**
+
+```bash
+$ davinci new-workflow alpha-package
+```
+
+**Description:**
+
+it triggers [build-publish-alpha-package](https://github.com/toptal/davinci-github-actions/tree/master/build-publish-alpha-package) GH Action.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run package:alpha-release`
+
+## typecheck
+
+Checks an App on Typescript issues
+
+**Example:**
+
+```bash
+$ davinci new-workflow typecheck
+```
+
+**Description:**
+
+it triggers `typecheck` GH Action
+
+## lint
+
+Checks an App for lint issues
+
+**Example:**
+
+```bash
+$ davinci new-workflow lint
+```
+
+**Description:**
+
+it triggers `lint` GH Action
+
+## unit-tests
+
+Conducts unit tests
+
+**Example:**
+
+```bash
+$ davinci new-workflow unit-tests
+```
+
+**Description:**
+
+it triggers `unit-tests` GH Action
+
+## integration-tests
+
+Conducts integration tests in a project using Cypress.
+
+**Example:**
+
+```bash
+$ davinci new-workflow integration-tests
+```
+
+**Description:**
+
+it triggers `integration-tests` GH Action
+
+## danger
+
+Checks if the PR title and commit messages comply with Toptal's standards
+
+**Example:**
+
+```bash
+$ davinci new-workflow danger
+```
+
+**Description:**
+
+it triggers `danger` GH Action
+
+## deploy-temploy
+
+Builds & Deploys application to Temploy
+
+**Example:**
+
+```bash
+$ davinci new-workflow deploy-temploy
+```
+
+**Description:**
+
+it creates a new instance of Docker image, pushes it to cloud and triggers an appropriate Jenkins job to deploy the image to temploy.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run temploy`
+
+## deploy
+
+Performs docker image build and deployment to staging/production environment
+
+**Example:**
+
+```bash
+$ davinci new-workflow deploy
+```
+
+**Description:**
+
+performs docker image build and deployment to staging/production environment. Consists of three Workflows:
+
+*   `Deploy` (davinci-deploy.yml)
+    *   it's triggered when PR is merged to `master` or `main` branch
+    *   It builds and pushes a new instance of Docker image to google cloud
+    *   if `davinci.yml` is present in the root folder:
+        *   and `deploy_staging` key is set to **true** then triggers `Deploy to Staging` GH Workflow
+        *   and `deploy` key is set to **true** then triggers `Deploy to Production` GH Workflow
+*   `Deploy to staging` (davinci-deploy-staging.yml)
+    *   Triggers Jenkins job for deployment to staging environment
+    *   how to trigger the Workflow manually:
+        *   add a new comment: `@toptal-bot run deploy-staging` in a PR. It will trigger a new GH Workflow. The latest commit in the PR branch will be taken to build a docker image.
+        *   In the `actions` tab, choose `Deploy to Staging` GH Workflow and provide a commit SHA
+*   `Deploy to production` (davinci-deploy-production.yml)
+    *   Triggers Jenkins job for deployment to production environment
+    *   how to trigger the Workflow manually:
+        *   In the `actions` tab, choose `Deploy to Production` GH Workflow and provide a commit SHA
+*   Find out more about how deployment works in [confluence](https://toptal-core.atlassian.net/l/c/ZN2K1f0r)
+
+## alpha-package
+
+Executes script to publish alpha version of package to NPM!???!!!
+
+**Example:**
+
+```bash
+$ davinci new-workflow alpha-package
+```
+
+**Description:**
+
+it triggers [build-publish-alpha-package](https://github.com/toptal/davinci-github-actions/tree/master/build-publish-alpha-package) GH Action.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run package:alpha-release`
+
+## typecheck
+
+Checks an App on Typescript issues
+
+**Example:**
+
+```bash
+$ davinci new-workflow typecheck
+```
+
+**Description:**
+
+it triggers `typecheck` GH Action
+
+## lint
+
+Checks an App for lint issues
+
+**Example:**
+
+```bash
+$ davinci new-workflow lint
+```
+
+**Description:**
+
+it triggers `lint` GH Action
+
+## unit-tests
+
+Conducts unit tests
+
+**Example:**
+
+```bash
+$ davinci new-workflow unit-tests
+```
+
+**Description:**
+
+it triggers `unit-tests` GH Action
+
+## integration-tests
+
+Conducts integration tests in a project using Cypress.
+
+**Example:**
+
+```bash
+$ davinci new-workflow integration-tests
+```
+
+**Description:**
+
+it triggers `integration-tests` GH Action
+
+## danger
+
+Checks if the PR title and commit messages comply with Toptal's standards
+
+**Example:**
+
+```bash
+$ davinci new-workflow danger
+```
+
+**Description:**
+
+it triggers `danger` GH Action
+
+## deploy-temploy
+
+Builds & Deploys application to Temploy
+
+**Example:**
+
+```bash
+$ davinci new-workflow deploy-temploy
+```
+
+**Description:**
+
+it creates a new instance of Docker image, pushes it to cloud and triggers an appropriate Jenkins job to deploy the image to temploy.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run temploy`
+
+## deploy
+
+Performs docker image build and deployment to staging/production environment
+
+**Example:**
+
+```bash
+$ davinci new-workflow deploy
+```
+
+**Description:**
+
+performs docker image build and deployment to staging/production environment. Consists of three Workflows:
+
+*   `Deploy` (davinci-deploy.yml)
+    *   it's triggered when PR is merged to `master` or `main` branch
+    *   It builds and pushes a new instance of Docker image to google cloud
+    *   if `davinci.yml` is present in the root folder:
+        *   and `deploy_staging` key is set to **true** then triggers `Deploy to Staging` GH Workflow
+        *   and `deploy` key is set to **true** then triggers `Deploy to Production` GH Workflow
+*   `Deploy to staging` (davinci-deploy-staging.yml)
+    *   Triggers Jenkins job for deployment to staging environment
+    *   how to trigger the Workflow manually:
+        *   add a new comment: `@toptal-bot run deploy-staging` in a PR. It will trigger a new GH Workflow. The latest commit in the PR branch will be taken to build a docker image.
+        *   In the `actions` tab, choose `Deploy to Staging` GH Workflow and provide a commit SHA
+*   `Deploy to production` (davinci-deploy-production.yml)
+    *   Triggers Jenkins job for deployment to production environment
+    *   how to trigger the Workflow manually:
+        *   In the `actions` tab, choose `Deploy to Production` GH Workflow and provide a commit SHA
+*   Find out more about how deployment works in [confluence](https://toptal-core.atlassian.net/l/c/ZN2K1f0r)
+
+## alpha-package
+
+Executes script to publish alpha version of package to NPM!
+
+**Example:**
+
+```bash
+$ davinci new-workflow alpha-package
+```
+
+**Description:**
+
+it triggers [build-publish-alpha-package](https://github.com/toptal/davinci-github-actions/tree/master/build-publish-alpha-package) GH Action.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run package:alpha-release`
+
+## typecheck
+
+Checks an App on Typescript issues
+
+**Example:**
+
+```bash
+$ davinci new-workflow typecheck
+```
+
+**Description:**
+
+it triggers `typecheck` GH Action
+
+## lint
+
+Checks an App for lint issues
+
+**Example:**
+
+```bash
+$ davinci new-workflow lint
+```
+
+**Description:**
+
+it triggers `lint` GH Action
+
+## unit-tests
+
+Conducts unit tests
+
+**Example:**
+
+```bash
+$ davinci new-workflow unit-tests
+```
+
+**Description:**
+
+it triggers `unit-tests` GH Action
+
+## integration-tests
+
+Conducts integration tests in a project using Cypress.
+
+**Example:**
+
+```bash
+$ davinci new-workflow integration-tests
+```
+
+**Description:**
+
+it triggers `integration-tests` GH Action
+
+## danger
+
+Checks if the PR title and commit messages comply with Toptal's standards
+
+**Example:**
+
+```bash
+$ davinci new-workflow danger
+```
+
+**Description:**
+
+it triggers `danger` GH Action
+
+## deploy-temploy
+
+Builds & Deploys application to Temploy
+
+**Example:**
+
+```bash
+$ davinci new-workflow deploy-temploy
+```
+
+**Description:**
+
+it creates a new instance of Docker image, pushes it to cloud and triggers an appropriate Jenkins job to deploy the image to temploy.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run temploy`
+
+## deploy
+
+Performs docker image build and deployment to staging/production environment
+
+**Example:**
+
+```bash
+$ davinci new-workflow deploy
+```
+
+**Description:**
+
+performs docker image build and deployment to staging/production environment. Consists of three Workflows:
+
+*   `Deploy` (davinci-deploy.yml)
+    *   it's triggered when PR is merged to `master` or `main` branch
+    *   It builds and pushes a new instance of Docker image to google cloud
+    *   if `davinci.yml` is present in the root folder:
+        *   and `deploy_staging` key is set to **true** then triggers `Deploy to Staging` GH Workflow
+        *   and `deploy` key is set to **true** then triggers `Deploy to Production` GH Workflow
+*   `Deploy to staging` (davinci-deploy-staging.yml)
+    *   Triggers Jenkins job for deployment to staging environment
+    *   how to trigger the Workflow manually:
+        *   add a new comment: `@toptal-bot run deploy-staging` in a PR. It will trigger a new GH Workflow. The latest commit in the PR branch will be taken to build a docker image.
+        *   In the `actions` tab, choose `Deploy to Staging` GH Workflow and provide a commit SHA
+*   `Deploy to production` (davinci-deploy-production.yml)
+    *   Triggers Jenkins job for deployment to production environment
+    *   how to trigger the Workflow manually:
+        *   In the `actions` tab, choose `Deploy to Production` GH Workflow and provide a commit SHA
+*   Find out more about how deployment works in [confluence](https://toptal-core.atlassian.net/l/c/ZN2K1f0r)
+
+## alpha-package
+
+Executes script to publish alpha version of package to NPM!
+
+**Example:**
+
+```bash
+$ davinci new-workflow alpha-package
+```
+
+**Description:**
+
+it triggers [build-publish-alpha-package](https://github.com/toptal/davinci-github-actions/tree/master/build-publish-alpha-package) GH Action.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run package:alpha-release`
+
+## typecheck
+
+Checks an App on Typescript issues
+
+**Example:**
+
+```bash
+$ davinci new-workflow typecheck
+```
+
+**Description:**
+
+it triggers `typecheck` GH Action
+
+## lint
+
+Checks an App for lint issues
+
+**Example:**
+
+```bash
+$ davinci new-workflow lint
+```
+
+**Description:**
+
+it triggers `lint` GH Action
+
+## unit-tests
+
+Conducts unit tests
+
+**Example:**
+
+```bash
+$ davinci new-workflow unit-tests
+```
+
+**Description:**
+
+it triggers `unit-tests` GH Action
+
+## integration-tests
+
+Conducts integration tests in a project using Cypress.
+
+**Example:**
+
+```bash
+$ davinci new-workflow integration-tests
+```
+
+**Description:**
+
+it triggers `integration-tests` GH Action
+
+## danger
+
+Checks if the PR title and commit messages comply with Toptal's standards
+
+**Example:**
+
+```bash
+$ davinci new-workflow danger
+```
+
+**Description:**
+
+it triggers `danger` GH Action
+
+## deploy-temploy
+
+Builds & Deploys application to Temploy
+
+**Example:**
+
+```bash
+$ davinci new-workflow deploy-temploy
+```
+
+**Description:**
+
+it creates a new instance of Docker image, pushes it to cloud and triggers an appropriate Jenkins job to deploy the image to temploy.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run temploy`
+
+## deploy
+
+Performs docker image build and deployment to staging/production environment
+
+**Example:**
+
+```bash
+$ davinci new-workflow deploy
+```
+
+**Description:**
+
+performs docker image build and deployment to staging/production environment. Consists of three Workflows:
+
+*   `Deploy` (davinci-deploy.yml)
+    *   it's triggered when PR is merged to `master` or `main` branch
+    *   It builds and pushes a new instance of Docker image to google cloud
+    *   if `davinci.yml` is present in the root folder:
+        *   and `deploy_staging` key is set to **true** then triggers `Deploy to Staging` GH Workflow
+        *   and `deploy` key is set to **true** then triggers `Deploy to Production` GH Workflow
+*   `Deploy to staging` (davinci-deploy-staging.yml)
+    *   Triggers Jenkins job for deployment to staging environment
+    *   how to trigger the Workflow manually:
+        *   add a new comment: `@toptal-bot run deploy-staging` in a PR. It will trigger a new GH Workflow. The latest commit in the PR branch will be taken to build a docker image.
+        *   In the `actions` tab, choose `Deploy to Staging` GH Workflow and provide a commit SHA
+*   `Deploy to production` (davinci-deploy-production.yml)
+    *   Triggers Jenkins job for deployment to production environment
+    *   how to trigger the Workflow manually:
+        *   In the `actions` tab, choose `Deploy to Production` GH Workflow and provide a commit SHA
+*   Find out more about how deployment works in [confluence](https://toptal-core.atlassian.net/l/c/ZN2K1f0r)
+
+## alpha-package
+
+Executes script to publish alpha version of package to NPM!!!!!!
+
+**Example:**
+
+```bash
+$ davinci new-workflow alpha-package
+```
+
+**Description:**
+
+it triggers [build-publish-alpha-package](https://github.com/toptal/davinci-github-actions/tree/master/build-publish-alpha-package) GH Action.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run package:alpha-release`
+
+## typecheck
+
+Checks an App on Typescript issues
+
+**Example:**
+
+```bash
+$ davinci new-workflow typecheck
+```
+
+**Description:**
+
+it triggers `typecheck` GH Action
+
+## lint
+
+Checks an App for lint issues
+
+**Example:**
+
+```bash
+$ davinci new-workflow lint
+```
+
+**Description:**
+
+it triggers `lint` GH Action
+
+## unit-tests
+
+Conducts unit tests
+
+**Example:**
+
+```bash
+$ davinci new-workflow unit-tests
+```
+
+**Description:**
+
+it triggers `unit-tests` GH Action
+
+## integration-tests
+
+Conducts integration tests in a project using Cypress.
+
+**Example:**
+
+```bash
+$ davinci new-workflow integration-tests
+```
+
+**Description:**
+
+it triggers `integration-tests` GH Action
+
+## danger
+
+Checks if the PR title and commit messages comply with Toptal's standards
+
+**Example:**
+
+```bash
+$ davinci new-workflow danger
+```
+
+**Description:**
+
+it triggers `danger` GH Action
+
+## deploy-temploy
+
+Builds & Deploys application to Temploy
+
+**Example:**
+
+```bash
+$ davinci new-workflow deploy-temploy
+```
+
+**Description:**
+
+it creates a new instance of Docker image, pushes it to cloud and triggers an appropriate Jenkins job to deploy the image to temploy.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run temploy`
+
+## deploy
+
+Performs docker image build and deployment to staging/production environment
+
+**Example:**
+
+```bash
+$ davinci new-workflow deploy
+```
+
+**Description:**
+
+performs docker image build and deployment to staging/production environment. Consists of three Workflows:
+
+*   `Deploy` (davinci-deploy.yml)
+    *   it's triggered when PR is merged to `master` or `main` branch
+    *   It builds and pushes a new instance of Docker image to google cloud
+    *   if `davinci.yml` is present in the root folder:
+        *   and `deploy_staging` key is set to **true** then triggers `Deploy to Staging` GH Workflow
+        *   and `deploy` key is set to **true** then triggers `Deploy to Production` GH Workflow
+*   `Deploy to staging` (davinci-deploy-staging.yml)
+    *   Triggers Jenkins job for deployment to staging environment
+    *   how to trigger the Workflow manually:
+        *   add a new comment: `@toptal-bot run deploy-staging` in a PR. It will trigger a new GH Workflow. The latest commit in the PR branch will be taken to build a docker image.
+        *   In the `actions` tab, choose `Deploy to Staging` GH Workflow and provide a commit SHA
+*   `Deploy to production` (davinci-deploy-production.yml)
+    *   Triggers Jenkins job for deployment to production environment
+    *   how to trigger the Workflow manually:
+        *   In the `actions` tab, choose `Deploy to Production` GH Workflow and provide a commit SHA
+*   Find out more about how deployment works in [confluence](https://toptal-core.atlassian.net/l/c/ZN2K1f0r)
+
+## alpha-package
+
+Executes script to publish alpha version of package to NPM!!!!!!
+
+**Example:**
+
+```bash
+$ davinci new-workflow alpha-package
+```
+
+**Description:**
+
+it triggers [build-publish-alpha-package](https://github.com/toptal/davinci-github-actions/tree/master/build-publish-alpha-package) GH Action.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run package:alpha-release`
+
+## typecheck
+
+Checks an App on Typescript issues
+
+**Example:**
+
+```bash
+$ davinci new-workflow typecheck
+```
+
+**Description:**
+
+it triggers `typecheck` GH Action
+
+## lint
+
+Checks an App for lint issues
+
+**Example:**
+
+```bash
+$ davinci new-workflow lint
+```
+
+**Description:**
+
+it triggers `lint` GH Action
+
+## unit-tests
+
+Conducts unit tests
+
+**Example:**
+
+```bash
+$ davinci new-workflow unit-tests
+```
+
+**Description:**
+
+it triggers `unit-tests` GH Action
+
+## integration-tests
+
+Conducts integration tests in a project using Cypress.
+
+**Example:**
+
+```bash
+$ davinci new-workflow integration-tests
+```
+
+**Description:**
+
+it triggers `integration-tests` GH Action
+
+## danger
+
+Checks if the PR title and commit messages comply with Toptal's standards
+
+**Example:**
+
+```bash
+$ davinci new-workflow danger
+```
+
+**Description:**
+
+it triggers `danger` GH Action
+
+## deploy-temploy
+
+Builds & Deploys application to Temploy
+
+**Example:**
+
+```bash
+$ davinci new-workflow deploy-temploy
+```
+
+**Description:**
+
+it creates a new instance of Docker image, pushes it to cloud and triggers an appropriate Jenkins job to deploy the image to temploy.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run temploy`
+
+## deploy
+
+Performs docker image build and deployment to staging/production environment
+
+**Example:**
+
+```bash
+$ davinci new-workflow deploy
+```
+
+**Description:**
+
+performs docker image build and deployment to staging/production environment. Consists of three Workflows:
+
+*   `Deploy` (davinci-deploy.yml)
+    *   it's triggered when PR is merged to `master` or `main` branch
+    *   It builds and pushes a new instance of Docker image to google cloud
+    *   if `davinci.yml` is present in the root folder:
+        *   and `deploy_staging` key is set to **true** then triggers `Deploy to Staging` GH Workflow
+        *   and `deploy` key is set to **true** then triggers `Deploy to Production` GH Workflow
+*   `Deploy to staging` (davinci-deploy-staging.yml)
+    *   Triggers Jenkins job for deployment to staging environment
+    *   how to trigger the Workflow manually:
+        *   add a new comment: `@toptal-bot run deploy-staging` in a PR. It will trigger a new GH Workflow. The latest commit in the PR branch will be taken to build a docker image.
+        *   In the `actions` tab, choose `Deploy to Staging` GH Workflow and provide a commit SHA
+*   `Deploy to production` (davinci-deploy-production.yml)
+    *   Triggers Jenkins job for deployment to production environment
+    *   how to trigger the Workflow manually:
+        *   In the `actions` tab, choose `Deploy to Production` GH Workflow and provide a commit SHA
+*   Find out more about how deployment works in [confluence](https://toptal-core.atlassian.net/l/c/ZN2K1f0r)
+
+## alpha-package
+
+Executes script to publish alpha version of package to NPM!
+
+**Example:**
+
+```bash
+$ davinci new-workflow alpha-package
+```
+
+**Description:**
+
+it triggers [build-publish-alpha-package](https://github.com/toptal/davinci-github-actions/tree/master/build-publish-alpha-package) GH Action.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run package:alpha-release`
+
+## typecheck
+
+Checks an App on Typescript issues
+
+**Example:**
+
+```bash
+$ davinci new-workflow typecheck
+```
+
+**Description:**
+
+it triggers `typecheck` GH Action
+
+## lint
+
+Checks an App for lint issues
+
+**Example:**
+
+```bash
+$ davinci new-workflow lint
+```
+
+**Description:**
+
+it triggers `lint` GH Action
+
+## unit-tests
+
+Conducts unit tests
+
+**Example:**
+
+```bash
+$ davinci new-workflow unit-tests
+```
+
+**Description:**
+
+it triggers `unit-tests` GH Action
+
+## integration-tests
+
+Conducts integration tests in a project using Cypress.
+
+**Example:**
+
+```bash
+$ davinci new-workflow integration-tests
+```
+
+**Description:**
+
+it triggers `integration-tests` GH Action
+
+## danger
+
+Checks if the PR title and commit messages comply with Toptal's standards
+
+**Example:**
+
+```bash
+$ davinci new-workflow danger
+```
+
+**Description:**
+
+it triggers `danger` GH Action
+
+## deploy-temploy
+
+Builds & Deploys application to Temploy
+
+**Example:**
+
+```bash
+$ davinci new-workflow deploy-temploy
+```
+
+**Description:**
+
+it creates a new instance of Docker image, pushes it to cloud and triggers an appropriate Jenkins job to deploy the image to temploy.
+
+**Example of usage:**
+
+Write a new comment in PR `@toptal-bot run temploy`
+
+## deploy
+
+Performs docker image build and deployment to staging/production environment
+
+**Example:**
+
+```bash
+$ davinci new-workflow deploy
+```
+
+**Description:**
+
+performs docker image build and deployment to staging/production environment. Consists of three Workflows:
+
+*   `Deploy` (davinci-deploy.yml)
+    *   it's triggered when PR is merged to `master` or `main` branch
+    *   It builds and pushes a new instance of Docker image to google cloud
+    *   if `davinci.yml` is present in the root folder:
+        *   and `deploy_staging` key is set to **true** then triggers `Deploy to Staging` GH Workflow
+        *   and `deploy` key is set to **true** then triggers `Deploy to Production` GH Workflow
+*   `Deploy to staging` (davinci-deploy-staging.yml)
+    *   Triggers Jenkins job for deployment to staging environment
+    *   how to trigger the Workflow manually:
+        *   add a new comment: `@toptal-bot run deploy-staging` in a PR. It will trigger a new GH Workflow. The latest commit in the PR branch will be taken to build a docker image.
+        *   In the `actions` tab, choose `Deploy to Staging` GH Workflow and provide a commit SHA
+*   `Deploy to production` (davinci-deploy-production.yml)
+    *   Triggers Jenkins job for deployment to production environment
+    *   how to trigger the Workflow manually:
+        *   In the `actions` tab, choose `Deploy to Production` GH Workflow and provide a commit SHA
+*   Find out more about how deployment works in [confluence](https://toptal-core.atlassian.net/l/c/ZN2K1f0r)
+
 ## Alias
 
 In all the commands you can use `davinci-workflow` directly if needed, instead of `davinci workflow`. This is not a recommended way to use `davinci`, but in very rare cases it might be useful.
-