Skip to content

Commit

Permalink
Readme for building the solution (#27)
Browse files Browse the repository at this point in the history
* build solution

* releaseDoc

Co-authored-by: Kanika Pasrija <kanikapasrija@Kanikas-MacBook-Pro.local>
  • Loading branch information
kanika1894 and Kanika Pasrija authored Nov 27, 2020
1 parent 2c2ff42 commit 37ef47d
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
11 changes: 11 additions & 0 deletions HowToBuild.md
Original file line number Diff line number Diff line change
@@ -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!
16 changes: 16 additions & 0 deletions ReleaseProcess.md
Original file line number Diff line number Diff line change
@@ -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`

0 comments on commit 37ef47d

Please sign in to comment.