Alpha version, generated from commit a8237cc

Author: rohit-drone

README.md

@@ -21,52 +21,7 @@ Generate new OAuth Credentials and copy
 
 ![OAuth Creds Screen](./docs/oauth-creds.png)
 
-## Usage With Github Actions
-
-[![test-release workflow](https://github.com/rohit-gohri/jira-ci-cd-integration/actions/workflows/test-release.yml/badge.svg)](https://github.com/rohit-gohri/jira-ci-cd-integration/actions/workflows/test-release.yml)
-
-### Add OAuth Creds as secrets to Github
-
-**See:** <https://docs.github.com/en/actions/reference/encrypted-secrets>
-
-- Add Client ID as `JIRA_CLIENT_ID`
-- Add Client Secret as `JIRA_CLIENT_SECRET`
-
-![Github Secrets](./docs/github-secrets.png)
-
-### Update Github Workflow
-
-#### Use in Builds Pipeline
-
-```yaml
-- name: Jira Integration
-  if: ${{ always() }}
-  uses: rohit-gohri/jira-ci-cd-integration@v0
-  with:
-    state: ${{ job.status }}
-    jira_instance: companyname # Subdomain for Jira Cloud
-    client_id: ${{ secrets.JIRA_CLIENT_ID }}
-    client_secret: ${{ secrets.JIRA_CLIENT_SECRET }}
-```
-
-#### Use in Deployment Pipeline
-
-Just provide an evironment to send a deployment event instead of a build event.
-
-```yaml
-- name: Jira Integration
-  if: ${{ always() }}
-  uses: rohit-gohri/jira-ci-cd-integration@v0
-  with:
-    state: ${{ job.status }}
-    environment: staging
-    issue: JCI-3, JCI-6 # Comma separated list of issues being deployed/released. You are expected to generate this yourself in a previous step
-    jira_instance: companyname # Subdomain for Jira Cloud
-    client_id: ${{ secrets.JIRA_CLIENT_ID }}
-    client_secret: ${{ secrets.JIRA_CLIENT_SECRET }}
-```
-
-## Use with Any Other CI/CD Providers
+## Use with Any CI/CD Provider with **Docker**
 
 Supported in providers which support running arbitrary Docker images (like Drone, Gitlab CI).
 
@@ -91,7 +46,7 @@ steps:
   - name: jira-integration
     image: boringdownload/jira-integration:v0
     environment:
-      BUILD_NAME: drone-pipeline
+      BUILD_NAME: drone-pipeline # or give any custom name
       JIRA_INSTANCE: companyname
       JIRA_CLIENT_ID:
         from_secret: jira_client_id
@@ -117,7 +72,7 @@ jira-build-integration-on-success:
   script: jira-integration
   variables:
     BUILD_STATE: successful
-    BUILD_NAME: gitlab-pipeline-name
+    BUILD_NAME: gitlab-pipeline-name # or give any custom name
     JIRA_INSTANCE: companyname
 
 jira-build-integration-on-failure:
@@ -143,60 +98,100 @@ jira-deploy-integration-on-failure:
     name: production
 ```
 
+## Usage With Github Actions
+
+[![test-release workflow](https://github.com/rohit-gohri/jira-ci-cd-integration/actions/workflows/test-release.yml/badge.svg)](https://github.com/rohit-gohri/jira-ci-cd-integration/actions/workflows/test-release.yml)
+
+### Add OAuth Creds as secrets to Github
+
+**See:** <https://docs.github.com/en/actions/reference/encrypted-secrets>
+
+- Add Client ID as `JIRA_CLIENT_ID`
+- Add Client Secret as `JIRA_CLIENT_SECRET`
+
+![Github Secrets](./docs/github-secrets.png)
+
+### Update Github Workflow
+
+#### Use in Builds Pipeline
+
+```yaml
+- name: Jira Integration
+  if: ${{ always() }}
+  uses: rohit-gohri/jira-ci-cd-integration@v0
+  with:
+    state: ${{ job.status }}
+    jira_instance: companyname # Subdomain for Jira Cloud
+    client_id: ${{ secrets.JIRA_CLIENT_ID }}
+    client_secret: ${{ secrets.JIRA_CLIENT_SECRET }}
+```
+
+#### Use in Deployment Pipeline
+
+Just provide an evironment to send a deployment event instead of a build event.
+
+```yaml
+- name: Jira Integration
+  if: ${{ always() }}
+  uses: rohit-gohri/jira-ci-cd-integration@v0
+  with:
+    state: ${{ job.status }}
+    environment: staging
+    issue: JCI-3, JCI-6 # Comma separated list of issues being deployed/released. You are expected to generate this yourself in a previous step
+    jira_instance: companyname # Subdomain for Jira Cloud
+    client_id: ${{ secrets.JIRA_CLIENT_ID }}
+    client_secret: ${{ secrets.JIRA_CLIENT_SECRET }}
+```
+
 ## Options
 
-Provide these options directly in case of Github Actions or via the env variable in the brackets for Docker.
+Provide these options via environment variables, or directly in case of Github Actions.
 
 ### Inputs
 
-#### jira_instance (JIRA_INSTANCE)
+#### jira_instance: JIRA_INSTANCE
 
 Sub Domain of Jira Cloud Instance. This part of the url: `https://<jira_instance>.atlassian.net`
 
-#### client_id (JIRA_CLIENT_ID)
+#### client_id: JIRA_CLIENT_ID
 
 ClientID of OAuth Creds
 
-#### client_secret (JIRA_CLIENT_SECRET)
+#### client_secret: JIRA_CLIENT_SECRET
 
 Client Secret of OAuth Creds
 
-#### event_type (JIRA_EVENT_TYPE) (optional)
+#### event_type: JIRA_EVENT_TYPE (optional)
 
 "build" or "deployment", (default is "build"). You can override this manually or just provide an `evironment` to send a deployment event instead of a build event.
 
-#### state (BUILD_STATE) (optional)
+#### state: BUILD_STATE (optional)
 
 "successful"/"success", "failed", or "canceled" (default is "successful")
 
-#### issue (JIRA_ISSUES) (optional)
+#### issue: JIRA_ISSUES (optional)
 
 Will be parsed from branch name automatically if absent. Or you can provide it according to your own logic. Can be multiple issues.
 
-#### token (optional)
-
-> Only for Github Action
-
-Github Token to get commit message in Pull Request Events. Since github context doesn't have commit message, we use the Github API to get it from sha.
-
 ### Pipeline Info
 
-#### Commit Message (COMMIT_MESSAGE)
+#### Commit Message: COMMIT_MESSAGE
 
-If you have the jira id in the commit message then provide this.
+If the tool can't detect your commit message you may provide a value directly. If you have the jira id in the commit message, it will be parsed.
 
-#### Pipeline Name (BUILD_NAME)
+#### Pipeline Name: BUILD_NAME
 
-A name for your pipeline
+A custom name for your pipeline
 
-#### Environment Name (BUILD_ENVIROMENT) (optional)
+#### Environment Name: BUILD_ENVIROMENT (optional)
 
 > NOTE: Only for Deployment events
 
-A name for your environment. We try to automatically infer this from your CI/CD provider.
+A name for your environment. The tool tries to automatically infer this from your CI/CD provider.
 
-#### Environment Type (BUILD_ENVIROMENT_TYPE) (optional)
+#### Environment Type: BUILD_ENVIROMENT_TYPE (optional)
 
 > NOTE: Automatically inferred from environment name
 
-We try to automatically parse this from environment but if you want to override then provide one of (`unmapped`, `development`, `testing`, `staging`, `production`)
+The tool tries to automatically parse this from environment but if you want to override then provide one of (`unmapped`, `development`, `testing`, `staging`, `production`)
+