From cecb5ccb7bf5b5b9cbf883de416ddcf9437686ab Mon Sep 17 00:00:00 2001 From: James Ives Date: Tue, 31 Mar 2020 08:48:19 -0400 Subject: [PATCH 1/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 63184b77..f6673360 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,18 +11,33 @@ email, or any other method with the owners of this repository before making a ch # Deploying -In order to deploy and test your own fork of this action, you must commit the required `node_modules` dependencies. +In order to deploy and test your own fork of this action, you must commit the required `node_modules` dependencies. Be sure to run `nvm use` before installing any dependencies. You can learn more about nvm [here](https://github.com/nvm-sh/nvm/blob/master/README.md). To do this you can follow the instructions below: +Install the project: + +``` +yarn install +``` + +Comment out the following in distribution branches: + ``` -# comment out in distribution branches # node_modules/ ``` +Build the project: + +``` +yarn build +``` + +Commit: + ``` $ git checkout -b branchnamehere $ git commit -a -m "prod dependencies" ``` -The `node_modules` folder should _not_ be included when making a pull request. \ No newline at end of file +The `node_modules` folder should _not_ be included when making a pull request. These are only required for GitHub Actions when it consumes the distribution branch branch, the `dev` branch of the project should be free from any dependencies or lib files. From fb58aa009168d7a5c683405b3ca4b7a3bd0b20a4 Mon Sep 17 00:00:00 2001 From: "dependabot-preview[bot]" <27856297+dependabot-preview[bot]@users.noreply.github.com> Date: Tue, 31 Mar 2020 08:48:44 -0400 Subject: [PATCH 2/3] Bump @types/node from 13.9.5 to 13.9.8 (#227) Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 13.9.5 to 13.9.8. - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases) - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node) Signed-off-by: dependabot-preview[bot] Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com> --- package.json | 2 +- yarn.lock | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/package.json b/package.json index 5dff4bbc..d7ba5319 100644 --- a/package.json +++ b/package.json @@ -39,7 +39,7 @@ }, "devDependencies": { "@types/jest": "25.1.4", - "@types/node": "13.9.5", + "@types/node": "13.9.8", "jest": "25.2.4", "jest-circus": "25.2.4", "prettier": "2.0.2", diff --git a/yarn.lock b/yarn.lock index 6f6702fa..883f87b4 100644 --- a/yarn.lock +++ b/yarn.lock @@ -559,9 +559,9 @@ version "7.0.4" resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.4.tgz#38fd73ddfd9b55abb1e1b2ed578cb55bd7b7d339" -"@types/node@13.9.5", "@types/node@>= 8": - version "13.9.5" - resolved "https://registry.yarnpkg.com/@types/node/-/node-13.9.5.tgz#59738bf30b31aea1faa2df7f4a5f55613750cf00" +"@types/node@13.9.8", "@types/node@>= 8": + version "13.9.8" + resolved "https://registry.yarnpkg.com/@types/node/-/node-13.9.8.tgz#09976420fc80a7a00bf40680c63815ed8c7616f4" "@types/normalize-package-data@^2.4.0": version "2.4.0" From b369adedad1ec0a629c4ee6c553ac5cfedc4219b Mon Sep 17 00:00:00 2001 From: James Ives Date: Tue, 31 Mar 2020 09:02:52 -0400 Subject: [PATCH 3/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3c68d4d2..143fa117 100644 --- a/README.md +++ b/README.md @@ -146,7 +146,7 @@ In addition to the deployment options you must also configure the following. | `COMMIT_MESSAGE` | If you need to customize the commit message for an integration you can do so. | `with` | **No** | | `CLEAN` | If your project generates hashed files on build you can use this option to automatically delete them from the deployment branch with each deploy. This option can be toggled on by setting it to `true`. | `with` | **No** | | `CLEAN_EXCLUDE` | If you need to use `CLEAN` but you'd like to preserve certain files or folders you can use this option. This should be formatted as an array but stored as a string. For example: `'["filename.js", "folder"]'` | `with` | **No** | -| `SINGLE_COMMIT` | This option can be toggled to `true` if you'd prefer to have a single commit on the deployment branch instead of maintaining the full history. Using this option will also cause any existing history to be wiped from the deployment branch. | `with` | **No** | +| `SINGLE_COMMIT` | This option can be toggled to `true` if you'd prefer to have a single commit on the deployment branch instead of maintaining the full history. **Using this option will also cause any existing history to be wiped from the deployment branch**. | `with` | **No** | | `WORKSPACE` | This should point to where your project lives on the virtual machine. The GitHub Actions environment will set this for you. It is only neccersary to set this variable if you're using the node module. | `with` | **No** | With the action correctly configured you should see the workflow trigger the deployment under the configured conditions.