diff --git a/HowToBuild.md b/HowToBuild.md new file mode 100644 index 00000000..d393fb23 --- /dev/null +++ b/HowToBuild.md @@ -0,0 +1,11 @@ +**Build the action** + +Open PowerShell, go to the directory where the repo is stored (.../cli/) and execute the following commands. + +**1.npm install** \ +npm install downloads dependencies defined in a package. json file and generates a node_modules folder with the installed modules. \ +**2.npm install -g @vercel/ncc** \ +**3.ncc build src/main.ts -s -o _build** \ +ncc is a simple CLI for compiling a Node.js module into a single file, together with all its dependencies, gcc-style. \ + +This builds the solution and create the required .js file(s). Good to go! \ No newline at end of file diff --git a/README.md b/README.md index 32e7816e..4f2436c0 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,7 @@ jobs: ### Configure Azure credentials as GitHub Secret: -To use any credentials like Azure Service Principal,add them as [secrets](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables) in the GitHub repository and then use them in the workflow. +To use any credentials like Azure Service Principal,add them as [secrets](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) in the GitHub repository and then use them in the workflow. Follow the steps to configure the secret: * Define a new secret under your repository settings, Add secret menu diff --git a/ReleaseProcess.md b/ReleaseProcess.md new file mode 100644 index 00000000..eb0eb0a6 --- /dev/null +++ b/ReleaseProcess.md @@ -0,0 +1,16 @@ +**Releasing a new version** + +Semanting versioning is used to release different versions of the action. Following steps are to be followed : + +1. Create a new branch for every major version. \ +Example, releases/v1, releases/v2. +2. For every minor and patch release for a major version, update the corresponding release branch. \ +Example, for releasing v1.1.1, update releases/v1. +3. Create tags for every new release (major/minor/patch). \ +Example,v1.0.0. , v1.0.1, v2.0.1, etc. and also have tags like v1, v2 for every major version release. +4. On releasing minor and patch versions, update the tag of the corresponding major version. \ +Example, for releasing v1.0.1, update the v1 tag to point to the ref of the current release. \ +The following commands are to be run on the release\v1 branch so that it picks the latest commit and updates the v1 tag accordingly : +(Ensure that you are on same commit locally as you want to release) +* `git tag -fa v1 -m "Update v1 tag"` +* `git push origin v1 --force`