Merge pull request #23 from joberstein/#21

#21: Use dist tag in deploy script

README.md

@@ -8,9 +8,9 @@ The Github Workflow for this repo automatically commits up-to-date dist based on
 
 The deploy script (./deploy.sh) will deploy to the 'release' breanch, which is orphaned so that it's history and contents is distinct from the 'master' branch, which contains all of the original source code.
 
-Callers wishing to use this action simply need to reference this repo per the standard convention (i.e. joberstein/[email protected]).
+Callers wishing to use this action should reference this repo by a versioned tag with the 'dist' suffix (i.e. joberstein/[email protected]-dist). The source code is released under the standard version tag (vX.Y.Z), whereas the actual deploy artifacts are accessible with (vX.Y.Z-dist) for the same version. The source code does not contain 'node_modules', the 'dist' folder, or any other deploy artifacts.
 
-# Scenarios
+# Scenarios  
 
 Validate commits for events like:
 
@@ -23,7 +23,7 @@ Validate commits for events like:
 
 ```yaml
 - name: Validate Commits
-  uses: joberstein/[email protected]
+  uses: joberstein/[email protected]-dist
   with:
     extra_config: @joberstein12/commitlint-config
 ```

deploy.sh

@@ -3,6 +3,7 @@
 SOURCE_BRANCH=$(git branch --show-current)
 TARGET_BRANCH="release"
 VERSION=$1
+NEW_TAG=v${VERSION}-dist
 
 if [ -z $VERSION ];
 then
@@ -30,8 +31,8 @@ git add -vA
 echo "Committing files..."
 git commit -vm "Deploy $VERSION"
 
-echo "Adding tag 'v${VERSION}'"
-git tag "v${VERSION}"
+echo "Adding tag '${NEW_TAG}'"
+git tag "$NEW_TAG"
 
 echo "Pushing commit..."
 git push origin -u "${TARGET_BRANCH}" \