align properties better with our existing integrations; Add a few ne… (…

…#8)

* align properties better with our existing integrations;  Add a few new propertiesl  retrieve related pull request

* delete checked in npm details and compiled typescript;  build in the action instead

* update READMEs, CONTRIBs, and build scripts

.github/workflows/push-workflow.yaml

@@ -8,11 +8,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@master
+      - name: Install dependencies
+        run: npm install
+      - name: Compile typescript
+        run: npm run build
       - name: Run mabl tests against deployment
         id: mabl-test-deployment
         uses: ./
         env:
           MABL_API_KEY: ${{ secrets.MABL_API_KEY }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           application-id: l-j3VqIO6lLLOOEoFTPSxA-a
           environment-id: rtb4kWD5LuTr2KxaHvwfaA-e

.gitignore

@@ -63,3 +63,5 @@ typings/
 # swap files
 *.swp
 
+#compiled js
+lib/*.js

CONTRIBUTING.md

@@ -1,27 +1,21 @@
 If you would like to contribute, please submit a PR. If you encounter an
 problem, please file an Issue in this repo.
 
-### Making updates
+### Releasing
 
-Actions need the compiled code checked in. This means your changes will only
-take effect if you run the build to generate .js files from the .ts Typescript
-files and check the .js files in as well.
-
-### Adding new dependencies
-
-Check in the Action with everything it needs to run. If you update dependencies
-you will need to commit the changes to Node modules as well.
+Releases are built on release branches. Each major release version should get
+its own branch, e.g. release_v1.  
+Releases can then be built from that branch by running
 
 ```bash
-# Remove any non-production dependencies
-npm prune --production
+# Compile release
+npm run release
 
-# Compile Typescript to ES6
-npm run build
+# Commit the built release files
+git commit -m "<version, e.g. v1.4> release"
 
-# Add the compiled Typescript output
-git add lib/
-
-# Add Node dependencies
-git add -f node_modules/*
+# Tag the release
+git tag <version, e.g. v1.4>
 ```
+
+Once the tag exists, you make a new release from it in the github UI.

README.md

@@ -24,14 +24,22 @@ jobs:
         uses: ./deploy-and-test/
         env:
           MABL_API_KEY: ${{ secrets.MABL_API_KEY }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
           application-id: <your-application-id-a>
           environment-id: <your-environment-id-e>
 ```
 
 ### Environment variables
 
 - `MABL_API_KEY` {string} - Your mabl API key
-  [available here](https://app.mabl.com/workspaces/-/settings/apis)
+  [available here](https://app.mabl.com/workspaces/-/settings/apis) This should
+  be installed as a secret in your github repository.
+- `GITHUB_TOKEN` {string} (optional) - The Github token for your repository. If
+  provided, the mabl action will associate a pull request with the deployment if
+  the commit being built is associated with any pull requests. This token is
+  automatically available as a secret in your repo but must be passed in
+  explicitly in order for the action to be able to access it.
 
 ### Inputs