From 42ac86566a80d25f7ac855ef4b9a4f972cf60410 Mon Sep 17 00:00:00 2001
From: Manas Kumar Maji <manasmaji4@gmail.com>
Date: Mon, 22 Mar 2021 10:55:16 +0530
Subject: [PATCH] Document the release process

---
 .github/ISSUE_TEMPLATE.md        | 13 ---------
 .github/PULL_REQUEST_TEMPLATE.md | 45 --------------------------------
 README.md                        | 12 ++++++---
 3 files changed, 9 insertions(+), 61 deletions(-)
 delete mode 100644 .github/ISSUE_TEMPLATE.md
 delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
deleted file mode 100644
index 594c724..0000000
--- a/.github/ISSUE_TEMPLATE.md
+++ /dev/null
@@ -1,13 +0,0 @@
-### Expected Behaviour
-
-### Actual Behaviour
-
-### Reproduce Scenario (including but not limited to)
-
-#### Steps to Reproduce
-
-#### Platform and Version
-
-#### Sample Code that illustrates the problem
-
-#### Logs taken while reproducing problem
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
deleted file mode 100644
index dd6a02a..0000000
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ /dev/null
@@ -1,45 +0,0 @@
-<!--- Provide a general summary of your changes in the Title above -->
-
-## Description
-
-<!--- Describe your changes in detail -->
-
-## Related Issue
-
-<!--- This project only accepts pull requests related to open issues -->
-<!--- If suggesting a new feature or change, please discuss it in an issue first -->
-<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
-<!--- Please link to the issue here: -->
-
-## Motivation and Context
-
-<!--- Why is this change required? What problem does it solve? -->
-
-## How Has This Been Tested?
-
-<!--- Please describe in detail how you tested your changes. -->
-<!--- Include details of your testing environment, and the tests you ran to -->
-<!--- see how your change affects other areas of the code, etc. -->
-
-## Screenshots (if appropriate):
-
-## Types of changes
-
-<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
-
-- [ ] Bug fix (non-breaking change which fixes an issue)
-- [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to change)
-
-## Checklist:
-
-<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
-<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
-
-- [ ] I have signed the [Adobe Open Source CLA](http://opensource.adobe.com/cla.html).
-- [ ] My code follows the code style of this project.
-- [ ] My change requires a change to the documentation.
-- [ ] I have updated the documentation accordingly.
-- [ ] I have read the **CONTRIBUTING** document.
-- [ ] I have added tests to cover my changes.
-- [ ] All new and existing tests passed.
diff --git a/README.md b/README.md
index 956e699..35bc0b9 100644
--- a/README.md
+++ b/README.md
@@ -222,17 +222,23 @@ EXAMPLE
 
 Refer to Code: *[src/commands/aem-migration/index-converter.js](./src/commands/aem-migration/index-converter.js)*
 
-
 # Adding New Commands
 
 Follow the steps below to add a new command:
 
 1. Create a new javascript file, named after the command, in `src/commands/aem-migration`.
 
-1. Use the contents of `src/commands/aem-migration/dispatcher-converter.js` as a starting point for your command,
+2. Use the contents of `src/commands/aem-migration/dispatcher-converter.js` as a starting point for your command,
  paying particular attention to the command's `flags`, `args`, and `description`. Refer to [https://oclif.io](https://oclif.io/) for additional information and features.
 
-1. Ensure that the file's exports include an object with a property matching the command name.
+3. Ensure that the file's exports include an object with a property matching the command name.
+
+# Publishing to npm
+This repository has been configured to automatically publish the plugin to `npm` registry.
+ It requires a commit to be made to the `master` branch with the required semver bump made
+ to the package version in the [package.json](./package.json). This commit will automatically
+ trigger the [Github Action](https://github.com/adobe/aio-cli-plugin-aem-cloud-service-migration/blob/master/.github/workflows/on-push-publish-to-npm.yml)
+ which will publish the package to `npm` registry.
 
 # Contributing