Version 3 (#44)

* Version 3 Beta

* README Updates

* More readme updates

* lock

* Restoring license/contrib

* One set of tests

* linting

* More tests

* Finish up unit tests

* Update action.yml

* Update main.yml

* Update README.md

* Update README.md

* README Changes

* Update README.md

* Unit testing job

* Some more stuff

* More cleanup

* Update README.md

* Unrequired

* Update CONTRIBUTING.md

* no guess

* Using Git Switch as opposed to checkout

* Force Commit

* Remove git

* Some more simplification

* Update git.ts

* changes

* Options

* w

* Debugging

* More debugging

* More debugging

* Debugging

* Debugging

* Debugging

* Debugging

* Debugging

* Debugging

* Debugging

* Debugging

* Debugging

* Debugging

* Debugging

* Debugging

* Debugging

* Debug

* Debugging

* Another 1

* Update git.ts

* Fixes root deployment

* Quiet Mode

* Quiet

* Excluding .github

* Update README.md

Author: JamesIves

.github/workflows/build.yml

@@ -0,0 +1,16 @@
+name: unit
+on:   
+  push:	
+    branches:	
+      - master
+jobs:
+  unit-test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@master
+
+    - name: Install and Test
+      run: |
+        npm install
+        npm run-script test

.github/workflows/main.yml renamed to .github/workflows/integration.yml

@@ -14,5 +14,4 @@ jobs:
       env:
         ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
         BRANCH: gh-pages
-        FOLDER: 'test/build'
-        BUILD_SCRIPT: npm run-script integrationTest
+        FOLDER: 'integration'

.gitignore

@@ -5,4 +5,5 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
-test/build
+
+node_modules

CONTRIBUTING.md

@@ -1,10 +1,28 @@
-# Contributing
+# Contributing	
 
-When contributing to this repository, please first discuss the change you wish to make via issue,
-email, or any other method with the owners of this repository before making a change. 
+When contributing to this repository, please first discuss the change you wish to make via issue,	
+email, or any other method with the owners of this repository before making a change. 	
 
-## Pull Request Best Practices
+## Pull Request Best Practices	
 
-1. Ensure that you've tested your feature/change yourself. As the primary focus of this project is deployment, providing a link to a deployed repository using your branch is preferred. You can reference the forked action using your GitHub username, for example `yourname/github-pages-deplpy-action@master`.
-2. Make sure you update the README if you've made a change that requires documentation.
+1. Ensure that you've tested your feature/change yourself. As the primary focus of this project is deployment, providing a link to a deployed repository using your branch is preferred. You can reference the forked action using your GitHub username, for example `yourname/github-pages-deplpy-action@master`.	
+2. Make sure you update the README if you've made a change that requires documentation.	
 3. When making a pull request, highlight any areas that may cause a breaking change so the maintainer can update the version number accordingly on the GitHub marketplace.
+
+# Deploying
+
+In order to deploy and test your own fork of this action, you must commit the required `node_modules` dependencies. 
+
+To do this you can follow the instructions below:
+
+```
+# comment out in distribution branches
+# node_modules/
+```
+
+```
+$ git checkout -b branchnamehere
+$ git commit -a -m "prod dependencies"
+```
+
+The `node_modules` folder should _not_ be included when making a pull request.

Dockerfile

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

LICENSE

@@ -1,8 +1,8 @@
 # GitHub Pages Deploy Action :rocket: 
 
-[![Actions Status](https://github.com/JamesIves/github-pages-deploy-action/workflows/integration/badge.svg)](https://github.com/JamesIves/github-pages-deploy-action/actions) [![View Action](https://img.shields.io/badge/view-action-blue.svg)](https://github.com/marketplace/actions/deploy-to-github-pages) [![Issues](https://img.shields.io/github/issues/JamesIves/github-pages-deploy-action.svg)](https://github.com/JamesIves/github-pages-deploy-action/issues)
+[![Build Status](https://github.com/JamesIves/github-pages-deploy-action/workflows/unit/badge.svg)](https://github.com/JamesIves/github-pages-deploy-action/actions)  [![Actions Status](https://github.com/JamesIves/github-pages-deploy-action/workflows/integration/badge.svg)](https://github.com/JamesIves/github-pages-deploy-action/actions) [![View Action](https://img.shields.io/badge/view-action-blue.svg?logo=github&color=orange)](https://github.com/marketplace/actions/deploy-to-github-pages) [![Version](https://img.shields.io/github/v/release/JamesIves/github-pages-deploy-action.svg?logo=github)](hhttps://github.com/JamesIves/github-pages-deploy-action/releases) 
 
-This [GitHub action](https://github.com/features/actions) will handle the building and deploy process of your project to [GitHub Pages](https://pages.github.com/). It can be configured to upload your production-ready code into any branch you'd like, including `gh-pages` and `docs`. This action is built on [Node](https://nodejs.org/en/), which means that you can call any optional build scripts your project requires prior to deploying.
+This [GitHub action](https://github.com/features/actions) will handle the  deploy process of your project to [GitHub Pages](https://pages.github.com/). It can be configured to upload your production-ready code into any branch you'd like, including `gh-pages` and `docs`.
 
 ## Getting Started :airplane:
 You can include the action in your workflow to trigger on any event that [GitHub actions supports](https://help.github.com/en/articles/events-that-trigger-workflows). If the remote branch that you wish to deploy to doesn't already exist the action will create it for you. Your workflow will also need to include the `actions/checkout` step before this workflow runs in order for the deployment to work. 
@@ -20,13 +20,12 @@ jobs:
       uses: actions/checkout@v1
 
     - name: Build and Deploy
-      uses: JamesIves/github-pages-deploy-action@releases/v2
-      env:
+      uses: JamesIves/github-pages-deploy-action@releases/v3
+      with:
         ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
         BASE_BRANCH: master # The branch the action should deploy from.
         BRANCH: gh-pages # The branch the action should deploy to.
         FOLDER: build # The folder the action should deploy.
-        BUILD_SCRIPT: npm install && npm run-script build # The build script the action should run prior to deploying.
 ```
 
 If you'd like to make it so the workflow only triggers on push events to specific branches then you can modify the `on` section. You'll still need to specify a `BASE_BRANCH` if you're deploying from a branch other than `master`.
@@ -40,20 +39,22 @@ on:
 
 ## Configuration 📁
 
-The `env` portion of the workflow **must** be configured before the action will work. You can add these in the `env` section found in the examples above. Any `secrets` must be referenced using the bracket syntax and stored in the GitHub repositories `Settings/Secrets` menu. You can learn more about setting environment variables with GitHub actions [here](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstepsenv).
+The `with` portion of the workflow **must** be configured before the action will work. You can add these in the `with` section found in the examples above. Any `secrets` must be referenced using the bracket syntax and stored in the GitHub repositories `Settings/Secrets` menu. You can learn more about setting environment variables with GitHub actions [here](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstepsenv).
 
 Below you'll find a description of what each option does.
 
 | Key  | Value Information | Type | Required |
 | ------------- | ------------- | ------------- | ------------- |
 | `GITHUB_TOKEN`  | In order for GitHub to trigger the rebuild of your page you must provide the action with the repositories provided GitHub token. This can be referenced in the workflow `yml` file by using `${{ secrets.GITHUB_TOKEN }}`. Only required if an access token is **not** provided. **Please note there is currently an issue affecting the use of this token, [you can learn more here](https://github.com/JamesIves/github-pages-deploy-action/issues/5)**. | `secrets` | **Yes** |
 | `ACCESS_TOKEN`  | Depending on the repository permissions you may need to provide the action with a GitHub personal access token instead of the provided GitHub token in order to deploy. You can [learn more about how to generate one here](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line). **This should be stored as a secret**. | `secrets` | **No** |
-| `BRANCH`  | This is the branch you wish to deploy to, for example `gh-pages` or `docs`.  | `env` | **Yes** |
-| `FOLDER`  | The folder in your repository that you want to deploy. If your build script compiles into a directory named `build` you'd put it here. **Folder paths cannot have a leading `/` or `./`**. | `env` | **Yes** |
-| `BASE_BRANCH`  | The base branch of your repository which you'd like to checkout prior to deploying. This defaults to `master`.  | `env` | **No** |
-| `BUILD_SCRIPT`  | If you require a build script to compile your code prior to pushing it you can add the script here. The Docker container which powers the action runs Node which means `npm` commands are valid. If you're using a static site generator such as Jekyll I'd suggest compiling the code prior to pushing it to your base branch.  | `env` | **No** |
-| `CNAME`  | If you're using a [custom domain](https://help.github.com/en/articles/using-a-custom-domain-with-github-pages), you will need to add the domain name to the `CNAME` environment variable. If you don't do this GitHub will wipe out your domain configuration after each deploy. This value will look something like this: `jives.dev`.  | `env` | **No** |
+| `BRANCH`  | This is the branch you wish to deploy to, for example `gh-pages` or `docs`.  | `with` | **Yes** |
+| `FOLDER`  | The folder in your repository that you want to deploy. If your build script compiles into a directory named `build` you'd put it here. **Folder paths cannot have a leading `/` or `./`**. | `with` | **Yes** |
+| `BASE_BRANCH`  | The base branch of your repository which you'd like to checkout prior to deploying. This defaults to `master`.  | `with` | **No** |
 
 With the action correctly configured you should see the workflow trigger the deployment under the configured conditions.
 
+### Additional Build Files
+
+This action maintains the full Git history of the deployment branch. Therefore if you're using a custom domain and require a `CNAME` file, or if you require the use of a `.nojekyll` file, you can safely commit these files directly into deployment branch without them being overridden after each deployment.
+
 ![Example](screenshot.png)

README.md

@@ -0,0 +1,161 @@
+// Initial env variable setup for tests.
+process.env["INPUT_FOLDER"] = "build";
+
+import { execute } from "../src/util";
+import { init, generateBranch, deploy } from "../src/git";
+import {action} from '../src/constants'
+import {cp} from '@actions/io';
+import _ from 'lodash';
+
+const originalAction = _.cloneDeep(action);
+
+jest.mock("../src/util", () => ({
+  execute: jest.fn()
+}));
+
+jest.mock("@actions/io", () => ({
+  cp: jest.fn()
+}));
+
+describe("git", () => {
+  afterEach(() => {
+    _.assignIn(action, originalAction);
+  });
+
+  describe("init", () => {
+    it("should execute three commands if a GitHub token is provided", async () => {
+
+      
+    Object.assign(action, {
+      build: 'build',
+      gitHubToken: '123',
+      pusher: {
+        name: 'asd',
+        email: 'as@cat'
+      }})
+
+      const call = await init();
+      expect(execute).toBeCalledTimes(3);
+      expect(call).toBe('Initialization step complete...')
+    });
+
+    it("should execute three commands if a Access token is provided", async () => {
+      
+      Object.assign(action, {
+        build: 'build',
+        accessToken: '123',
+        pusher: {
+          name: 'asd',
+          email: 'as@cat'
+        }})
+  
+        const call = await init();
+  
+        expect(execute).toBeCalledTimes(3);
+        expect(call).toBe('Initialization step complete...')
+      });
+
+    it("should fail if there is no provided GitHub Token or Access Token", async () => {
+      Object.assign(action, {
+        build: 'build',
+        pusher: {
+          name: 'asd',
+          email: 'as@cat'
+        }})
+
+        const call = await init()
+
+        expect(execute).toBeCalledTimes(0);
+        expect(call).toBe('Initialization step complete...')
+    })
+
+    it("should fail if the build folder begins with a /", async () => {
+      Object.assign(action, {
+        accessToken: '123',
+        build: '/',
+        pusher: {
+          name: 'asd',
+          email: 'as@cat'
+        }})
+
+        const call = await init()
+
+        expect(execute).toBeCalledTimes(0);
+        expect(call).toBe('Initialization step complete...')
+    })
+
+    it("should fail if the build folder begins with a ./", async () => {
+      Object.assign(action, {
+        accessToken: '123',
+        build: './',
+        pusher: {
+          name: 'asd',
+          email: 'as@cat'
+        }})
+
+        const call = await init()
+
+        expect(execute).toBeCalledTimes(0);
+        expect(call).toBe('Initialization step complete...')
+    })
+
+    it("should not fail if root is used", async () => {
+      Object.assign(action, {
+        accessToken: '123',
+        build: '.',
+        pusher: {
+          name: 'asd',
+          email: 'as@cat'
+        }})
+
+        const call = await init()
+
+        expect(execute).toBeCalledTimes(3);
+        expect(call).toBe('Initialization step complete...')
+    })
+  });
+
+  describe('generateBranch', () => {
+    it('should execute five commands', async () => {
+      const call = await generateBranch();
+      expect(execute).toBeCalledTimes(6);
+      expect(call).toBe('Deployment branch creation step complete...')
+    })
+  })
+
+  describe('deploy', () => {
+    it('should execute five commands', async () => {
+      Object.assign(action, {
+        build: 'build',
+        gitHubToken: '123',
+        pusher: {
+          name: 'asd',
+          email: 'as@cat'
+        }})
+  
+      const call = await deploy();
+
+      // Includes the call to generateBranch
+      expect(execute).toBeCalledTimes(14);
+      expect(cp).toBeCalledTimes(1)
+      expect(call).toBe('Commit step complete...')
+    })
+
+    it('should execute six commands if root is used', async () => {
+      Object.assign(action, {
+        build: '.',
+        gitHubToken: '123',
+        pusher: {
+          name: 'asd',
+          email: 'as@cat'
+        }})
+  
+      const call = await deploy();
+
+      // Includes the call to generateBranch
+      expect(execute).toBeCalledTimes(15);
+      expect(cp).toBeCalledTimes(0)
+      expect(call).toBe('Commit step complete...')
+    })
+  })
+});

__tests__/git.test.ts

@@ -0,0 +1,23 @@
+import {execute} from '../src/util';
+import {exec} from '@actions/exec';
+
+jest.mock('@actions/exec', () => ({
+  exec: jest.fn()
+}))
+
+describe('util', () => {
+  describe('execute', () => {
+    it('should be called with the correct arguements', async() => {
+      await execute('echo Montezuma', './')
+    
+      expect(exec).toBeCalledWith(
+        "echo Montezuma", [], {
+          cwd: "./",
+          listeners: {
+            stdout: expect.any(Function)
+          }
+        }
+      )
+    });
+  })
+})

__tests__/util.test.ts

@@ -1,9 +1,9 @@
 name: 'Deploy to GitHub Pages'
-description: 'This action will handle the building and deploying process of your project to GitHub Pages.'
+description: 'This action will handle the deployment process of your project to GitHub Pages.'
 author: 'James Ives <[email protected]>'
 runs:
-  using: 'docker'
-  image: 'Dockerfile'
+  using: 'node12'
+  main: 'lib/main.js'
 branding:
   icon: 'git-commit'
   color: 'orange'