'
+ minimum: 500
+
+ - name: Deploy to GitHub Pages
+ uses: JamesIves/github-pages-deploy-action@4.1.9
+ with:
+ branch: dev
+ folder: '.'
diff --git a/.nvmrc b/.nvmrc
index 82f87fa0..e24183e5 100644
--- a/.nvmrc
+++ b/.nvmrc
@@ -1 +1 @@
-v12.18.4
+v14.18.1
diff --git a/.prettierrc.json b/.prettierrc.json
index 386485a7..c34bafcb 100644
--- a/.prettierrc.json
+++ b/.prettierrc.json
@@ -6,6 +6,5 @@
"singleQuote": true,
"trailingComma": "none",
"bracketSpacing": false,
- "arrowParens": "avoid",
- "parser": "typescript"
-}
\ No newline at end of file
+ "arrowParens": "avoid"
+}
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
index ad25d444..c1b7046a 100644
--- a/CODE_OF_CONDUCT.md
+++ b/CODE_OF_CONDUCT.md
@@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment
include:
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
- professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+ professional setting
## Our Responsibilities
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1ec71553..756e1b52 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,15 +1,15 @@
# Contributing âī¸
-When contributing to this repository, please first discuss the change you wish to make via issue,
+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](https://jamesiv.es) before making a change. If you are planning to work on an issue that already exists please let us know before writing any code incase it's already in flight!
-## Before Making a Pull Request đ
+## Before Making a Pull Request đ
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@dev`.
2. Ensure your change passes all of the integration tests.
-3. Make sure you update the README if you've made a change that requires documentation.
+3. Make sure you update the README if you've made a change that requires documentation.
4. 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 and package registries.
-5. Make sure you've formatted and linted your code. You can do this by running `yarn format` and `yarn lint`.
+5. Make sure you've formatted and linted your code. You can do this by running `yarn format` and `yarn lint`.
6. Fix or add any tests where applicable. You can run `yarn test` to run the suite. As this action is small in scope it's important that a high level of test coverage is maintained. All tests are written using [Jest](https://jestjs.io/).
7. As this package is written in [TypeScript](https://www.typescriptlang.org/) please ensure all typing is accurate and the action compiles correctly by running `yarn build`.
@@ -32,7 +32,7 @@ Comment out the following in distribution branches:
# lib/
```
-Build the project:
+Build the project:
```
yarn build
@@ -49,6 +49,6 @@ The `node_modules` and `lib` folders should _not_ be included when making a pull
## Resources đĄ
-* [TypeScript](https://www.typescriptlang.org/)
-* [Jest](https://jestjs.io/)
-* [GitHub Actions Documentation](https://help.github.com/en/actions)
+- [TypeScript](https://www.typescriptlang.org/)
+- [Jest](https://jestjs.io/)
+- [GitHub Actions Documentation](https://help.github.com/en/actions)
diff --git a/LICENSE b/LICENSE
index 476497ac..4fef0fdd 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,6 @@
MIT License
-Copyright (c) 2020 James Ives
+Copyright (c) 2021 James Ives
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
@@ -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.
\ No newline at end of file
+SOFTWARE.
diff --git a/README.md b/README.md
index f6d4c05a..e37fff6f 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
@@ -31,11 +31,11 @@
- This GitHub Action will automatically deploy your project to GitHub Pages. It can be configured to push your production-ready code into any branch you'd like, including gh-pages and docs. It can also handle cross repository deployments too. + This GitHub Action will automatically deploy your project to GitHub Pages. It can be configured to push your production-ready code into any branch you'd like, including gh-pages and docs. It can also handle cross repository deployments and works with GitHub Enterprise too.
- 
+ 
```yml @@ -314,7 +312,7 @@ name: Build and Deploy on: push: branches: - - master + - main jobs: deploy: runs-on: ubuntu-latest @@ -324,11 +322,11 @@ jobs: - name: Install and Build đ§ # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built. run: | - npm install + npm ci npm run build - name: Deploy đ - uses: JamesIves/github-pages-deploy-action@4.0.0 + uses: JamesIves/github-pages-deploy-action@4.1.9 with: branch: gh-pages folder: build @@ -337,6 +335,7 @@ jobs: special-file.txt some/*.txt ``` +
diff --git a/SECURITY.md b/SECURITY.md
index a0811c8f..917da715 100644
--- a/SECURITY.md
+++ b/SECURITY.md
@@ -7,8 +7,8 @@ The current version is actively maintained and will receive frequent updates and
| Version | Supported |
| ------- | ------------------ |
| 4.0.x | :white_check_mark: |
-| < 3.0 | :x: |
+| < 4.0.0 | :x: |
## Reporting a Vulnerability
-Please disclose any security vulnerabilities either through the issues interface (as a bug) or by [emailing the project maintainer](https://jamesiv.es).
+Please disclose any security vulnerabilities either through the issues interface (as a bug) or by [emailing the project maintainer](https://jamesiv.es). Please bare in mind that this project is voluntarily maintained and updates will be worked on based on availability.
diff --git a/__tests__/git.test.ts b/__tests__/git.test.ts
index 5331158b..366da22b 100644
--- a/__tests__/git.test.ts
+++ b/__tests__/git.test.ts
@@ -1,4 +1,3 @@
-/* eslint-disable import/first */
// Initial env variable setup for tests.
process.env['INPUT_FOLDER'] = 'build'
process.env['GITHUB_SHA'] = '123'
@@ -42,6 +41,7 @@ describe('git', () => {
describe('init', () => {
it('should execute commands', async () => {
Object.assign(action, {
+ hostname: 'github.com',
silent: false,
repositoryPath: 'JamesIves/github-pages-deploy-action',
token: '123',
@@ -55,7 +55,7 @@ describe('git', () => {
})
await init(action)
- expect(execute).toBeCalledTimes(5)
+ expect(execute).toBeCalledTimes(6)
})
it('should catch when a function throws an error', async () => {
@@ -64,6 +64,7 @@ describe('git', () => {
})
Object.assign(action, {
+ hostname: 'github.com',
silent: false,
repositoryPath: 'JamesIves/github-pages-deploy-action',
token: '123',
@@ -79,7 +80,7 @@ describe('git', () => {
try {
await init(action)
} catch (error) {
- expect(error.message).toBe(
+ expect(error instanceof Error && error.message).toBe(
'There was an error initializing the repository: Mocked throw â'
)
}
@@ -87,6 +88,7 @@ describe('git', () => {
it('should correctly continue when it cannot unset a git config value', async () => {
Object.assign(action, {
+ hostname: 'github.com',
silent: false,
repositoryPath: 'JamesIves/github-pages-deploy-action',
token: '123',
@@ -100,7 +102,7 @@ describe('git', () => {
})
await init(action)
- expect(execute).toBeCalledTimes(5)
+ expect(execute).toBeCalledTimes(6)
})
it('should not unset git config if a user is using ssh', async () => {
@@ -108,6 +110,7 @@ describe('git', () => {
process.env.CI = 'true'
Object.assign(action, {
+ hostname: 'github.com',
silent: false,
repositoryPath: 'JamesIves/github-pages-deploy-action',
sshKey: true,
@@ -121,13 +124,14 @@ describe('git', () => {
})
await init(action)
- expect(execute).toBeCalledTimes(4)
+ expect(execute).toBeCalledTimes(5)
process.env.CI = undefined
})
it('should correctly continue when it cannot remove origin', async () => {
Object.assign(action, {
+ hostname: 'github.com',
silent: false,
repositoryPath: 'JamesIves/github-pages-deploy-action',
token: '123',
@@ -141,13 +145,14 @@ describe('git', () => {
})
await init(action)
- expect(execute).toBeCalledTimes(5)
+ expect(execute).toBeCalledTimes(6)
})
})
describe('deploy', () => {
it('should execute commands', async () => {
Object.assign(action, {
+ hostname: 'github.com',
silent: false,
folder: 'assets',
branch: 'branch',
@@ -163,13 +168,14 @@ describe('git', () => {
const response = await deploy(action)
// Includes the call to generateWorktree
- expect(execute).toBeCalledTimes(11)
+ expect(execute).toBeCalledTimes(13)
expect(rmRF).toBeCalledTimes(1)
expect(response).toBe(Status.SUCCESS)
})
it('should not push when asked to dryRun', async () => {
Object.assign(action, {
+ hostname: 'github.com',
silent: false,
dryRun: true,
folder: 'assets',
@@ -185,13 +191,14 @@ describe('git', () => {
const response = await deploy(action)
// Includes the call to generateWorktree
- expect(execute).toBeCalledTimes(10)
+ expect(execute).toBeCalledTimes(12)
expect(rmRF).toBeCalledTimes(1)
expect(response).toBe(Status.SUCCESS)
})
it('should execute commands with single commit toggled', async () => {
Object.assign(action, {
+ hostname: 'github.com',
silent: false,
folder: 'other',
folderPath: 'other',
@@ -209,12 +216,13 @@ describe('git', () => {
await deploy(action)
// Includes the call to generateWorktree
- expect(execute).toBeCalledTimes(10)
+ expect(execute).toBeCalledTimes(13)
expect(rmRF).toBeCalledTimes(1)
})
it('should execute commands with single commit toggled and existing branch', async () => {
Object.assign(action, {
+ hostname: 'github.com',
silent: false,
folder: 'other',
folderPath: 'other',
@@ -232,12 +240,13 @@ describe('git', () => {
await deploy(action)
// Includes the call to generateWorktree
- expect(execute).toBeCalledTimes(9)
+ expect(execute).toBeCalledTimes(12)
expect(rmRF).toBeCalledTimes(1)
})
it('should execute commands with single commit and dryRun toggled', async () => {
Object.assign(action, {
+ hostname: 'github.com',
silent: false,
folder: 'other',
folderPath: 'other',
@@ -256,7 +265,7 @@ describe('git', () => {
await deploy(action)
// Includes the call to generateWorktree
- expect(execute).toBeCalledTimes(9)
+ expect(execute).toBeCalledTimes(12)
expect(rmRF).toBeCalledTimes(1)
})
@@ -270,6 +279,7 @@ describe('git', () => {
})
Object.assign(action, {
+ hostname: 'github.com',
silent: false,
folder: 'assets',
folderPath: 'assets',
@@ -286,7 +296,7 @@ describe('git', () => {
const response = await deploy(action)
// Includes the call to generateWorktree
- expect(execute).toBeCalledTimes(11)
+ expect(execute).toBeCalledTimes(13)
expect(rmRF).toBeCalledTimes(1)
expect(fs.existsSync).toBeCalledTimes(2)
expect(response).toBe(Status.SUCCESS)
@@ -300,6 +310,7 @@ describe('git', () => {
it('should execute commands with clean options', async () => {
process.env.GITHUB_SHA = ''
Object.assign(action, {
+ hostname: 'github.com',
silent: false,
folder: 'other',
folderPath: 'other',
@@ -317,13 +328,14 @@ describe('git', () => {
await deploy(action)
// Includes the call to generateWorktree
- expect(execute).toBeCalledTimes(8)
+ expect(execute).toBeCalledTimes(10)
expect(rmRF).toBeCalledTimes(1)
})
})
it('should execute commands with clean options stored as an array', async () => {
Object.assign(action, {
+ hostname: 'github.com',
silent: false,
folder: 'assets',
folderPath: 'assets',
@@ -341,12 +353,13 @@ describe('git', () => {
await deploy(action)
// Includes the call to generateWorktree
- expect(execute).toBeCalledTimes(8)
+ expect(execute).toBeCalledTimes(10)
expect(rmRF).toBeCalledTimes(1)
})
it('should gracefully handle target folder', async () => {
Object.assign(action, {
+ hostname: 'github.com',
silent: false,
folder: '.',
branch: 'branch',
@@ -360,13 +373,14 @@ describe('git', () => {
await deploy(action)
- expect(execute).toBeCalledTimes(8)
+ expect(execute).toBeCalledTimes(10)
expect(rmRF).toBeCalledTimes(1)
expect(mkdirP).toBeCalledTimes(1)
})
it('should stop early if there is nothing to commit', async () => {
Object.assign(action, {
+ hostname: 'github.com',
silent: false,
folder: 'assets',
branch: 'branch',
@@ -379,7 +393,7 @@ describe('git', () => {
})
const response = await deploy(action)
- expect(execute).toBeCalledTimes(8)
+ expect(execute).toBeCalledTimes(10)
expect(rmRF).toBeCalledTimes(1)
expect(response).toBe(Status.SKIPPED)
})
@@ -390,6 +404,7 @@ describe('git', () => {
})
Object.assign(action, {
+ hostname: 'github.com',
silent: false,
folder: 'assets',
branch: 'branch',
@@ -404,7 +419,7 @@ describe('git', () => {
try {
await deploy(action)
} catch (error) {
- expect(error.message).toBe(
+ expect(error instanceof Error && error.message).toBe(
'The deploy step encountered an error: Mocked throw â'
)
}
diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts
index e7d85d22..7cf28f8f 100644
--- a/__tests__/main.test.ts
+++ b/__tests__/main.test.ts
@@ -1,8 +1,8 @@
-/* eslint-disable import/first */
// Initial env variable setup for tests.
process.env['INPUT_FOLDER'] = 'build'
process.env['GITHUB_SHA'] = '123'
process.env['INPUT_DEBUG'] = 'debug'
+process.env['GITHUB_REF_NAME'] = 'test'
import '../src/main'
import {action, TestFlag} from '../src/constants'
@@ -38,9 +38,10 @@ describe('main', () => {
it('should run through the commands', async () => {
Object.assign(action, {
repositoryPath: 'JamesIves/github-pages-deploy-action',
- folder: 'assets',
+ folder: '.github/assets',
branch: 'branch',
token: '123',
+ hostname: 'github.com',
pusher: {
name: 'asd',
email: 'as@cat'
@@ -49,15 +50,16 @@ describe('main', () => {
debug: true
})
await run(action)
- expect(execute).toBeCalledTimes(13)
+ expect(execute).toBeCalledTimes(16)
expect(rmRF).toBeCalledTimes(1)
expect(exportVariable).toBeCalledTimes(1)
})
it('should run through the commands and succeed', async () => {
Object.assign(action, {
+ hostname: 'github.com',
repositoryPath: 'JamesIves/github-pages-deploy-action',
- folder: 'assets',
+ folder: '.github/assets',
branch: 'branch',
token: '123',
sshKey: true,
@@ -68,14 +70,15 @@ describe('main', () => {
isTest: TestFlag.HAS_CHANGED_FILES
})
await run(action)
- expect(execute).toBeCalledTimes(16)
+ expect(execute).toBeCalledTimes(19)
expect(rmRF).toBeCalledTimes(1)
expect(exportVariable).toBeCalledTimes(1)
})
it('should throw if an error is encountered', async () => {
Object.assign(action, {
- folder: 'assets',
+ hostname: 'github.com',
+ folder: '.github/assets',
branch: 'branch',
token: null,
sshKey: null,
diff --git a/__tests__/ssh.test.ts b/__tests__/ssh.test.ts
index 17cc90f4..39481506 100644
--- a/__tests__/ssh.test.ts
+++ b/__tests__/ssh.test.ts
@@ -43,6 +43,7 @@ describe('configureSSH', () => {
it('should skip client configuration if sshKey is set to true', async () => {
Object.assign(action, {
+ hostname: 'github.com',
silent: false,
folder: 'assets',
branch: 'branch',
@@ -67,6 +68,7 @@ describe('configureSSH', () => {
})
Object.assign(action, {
+ hostname: 'github.com',
silent: false,
folder: 'assets',
branch: 'branch',
@@ -91,6 +93,7 @@ describe('configureSSH', () => {
})
Object.assign(action, {
+ hostname: 'github.com',
silent: false,
folder: 'assets',
branch: 'branch',
@@ -115,6 +118,7 @@ describe('configureSSH', () => {
})
Object.assign(action, {
+ hostname: 'github.com',
silent: false,
folder: 'assets',
branch: 'branch',
@@ -129,7 +133,7 @@ describe('configureSSH', () => {
try {
await configureSSH(action)
} catch (error) {
- expect(error.message).toBe(
+ expect(error instanceof Error && error.message).toBe(
'The ssh client configuration encountered an error: Mocked throw â'
)
}
diff --git a/__tests__/util.test.ts b/__tests__/util.test.ts
index c0679849..fa5e1c6a 100644
--- a/__tests__/util.test.ts
+++ b/__tests__/util.test.ts
@@ -5,7 +5,9 @@ import {
generateRepositoryPath,
generateFolderPath,
suppressSensitiveInformation,
- checkParameters
+ checkParameters,
+ stripProtocolFromUrl,
+ extractErrorMessage
} from '../src/util'
describe('util', () => {
@@ -79,11 +81,13 @@ describe('util', () => {
branch: '123',
workspace: 'src/',
folder: 'build',
+ hostname: 'github.com',
token: null,
sshKey: 'real_token',
silent: false,
isTest: TestFlag.NONE
}
+
expect(generateRepositoryPath(action)).toEqual(
'git@github.com:JamesIves/github-pages-deploy-action'
)
@@ -95,13 +99,15 @@ describe('util', () => {
branch: '123',
workspace: 'src/',
folder: 'build',
+ hostname: 'enterprise.github.com',
token: '123',
sshKey: null,
silent: false,
isTest: TestFlag.NONE
}
+
expect(generateRepositoryPath(action)).toEqual(
- 'https://x-access-token:123@github.com/JamesIves/github-pages-deploy-action.git'
+ 'https://x-access-token:123@enterprise.github.com/JamesIves/github-pages-deploy-action.git'
)
})
@@ -217,7 +223,7 @@ describe('util', () => {
try {
checkParameters(action)
} catch (e) {
- expect(e.message).toMatch(
+ expect(e instanceof Error && e.message).toMatch(
'No deployment token/method was provided. You must provide the action with either a Personal Access Token or the GitHub Token secret in order to deploy. If you wish to use an ssh deploy token then you must set SSH to true.'
)
}
@@ -237,7 +243,7 @@ describe('util', () => {
try {
checkParameters(action)
} catch (e) {
- expect(e.message).toMatch(
+ expect(e instanceof Error && e.message).toMatch(
'No deployment token/method was provided. You must provide the action with either a Personal Access Token or the GitHub Token secret in order to deploy. If you wish to use an ssh deploy token then you must set SSH to true.'
)
}
@@ -257,7 +263,7 @@ describe('util', () => {
try {
checkParameters(action)
} catch (e) {
- expect(e.message).toMatch('Branch is required.')
+ expect(e instanceof Error && e.message).toMatch('Branch is required.')
}
})
@@ -275,7 +281,7 @@ describe('util', () => {
try {
checkParameters(action)
} catch (e) {
- expect(e.message).toMatch(
+ expect(e instanceof Error && e.message).toMatch(
'You must provide the action with a folder to deploy.'
)
}
@@ -296,10 +302,48 @@ describe('util', () => {
action.folderPath = generateFolderPath(action)
checkParameters(action)
} catch (e) {
- expect(e.message).toMatch(
+ expect(e instanceof Error && e.message).toMatch(
`The directory you're trying to deploy named notARealFolder doesn't exist. Please double check the path and any prerequisite build scripts and try again. â`
)
}
})
})
+
+ describe('stripProtocolFromUrl', () => {
+ it('removes https', () => {
+ expect(stripProtocolFromUrl('https://github.com')).toBe('github.com')
+ })
+
+ it('removes http', () => {
+ expect(stripProtocolFromUrl('http://github.com')).toBe('github.com')
+ })
+
+ it('removes https|http and www.', () => {
+ expect(stripProtocolFromUrl('http://www.github.com')).toBe('github.com')
+ })
+
+ it('works with a url that is not github.com', () => {
+ expect(stripProtocolFromUrl('http://github.enterprise.jamesiv.es')).toBe(
+ 'github.enterprise.jamesiv.es'
+ )
+ })
+ })
+
+ describe('extractErrorMessage', () => {
+ it('gets the message of a Error', () => {
+ expect(extractErrorMessage(new Error('a error message'))).toBe(
+ 'a error message'
+ )
+ })
+
+ it('gets the message of a string', () => {
+ expect(extractErrorMessage('a error message')).toBe('a error message')
+ })
+
+ it('gets the message of a object', () => {
+ expect(extractErrorMessage({special: 'a error message'})).toBe(
+ `{"special":"a error message"}`
+ )
+ })
+ })
})
diff --git a/__tests__/worktree.error.test.ts b/__tests__/worktree.error.test.ts
index 57676ebd..73f91410 100644
--- a/__tests__/worktree.error.test.ts
+++ b/__tests__/worktree.error.test.ts
@@ -16,6 +16,7 @@ describe('generateWorktree', () => {
try {
await generateWorktree(
{
+ hostname: 'github.com',
workspace: 'somewhere',
singleCommit: false,
branch: 'gh-pages',
@@ -27,7 +28,7 @@ describe('generateWorktree', () => {
true
)
} catch (error) {
- expect(error.message).toBe(
+ expect(error instanceof Error && error.message).toBe(
'There was an error creating the worktree: Mocked throw â'
)
}
diff --git a/__tests__/worktree.test.ts b/__tests__/worktree.test.ts
index 91626f7c..4d5e1e96 100644
--- a/__tests__/worktree.test.ts
+++ b/__tests__/worktree.test.ts
@@ -81,6 +81,7 @@ describe('generateWorktree', () => {
const workspace = clonedir as string
await generateWorktree(
{
+ hostname: 'github.com',
workspace,
singleCommit: false,
branch: 'gh-pages',
@@ -111,6 +112,7 @@ describe('generateWorktree', () => {
const workspace = clonedir as string
await generateWorktree(
{
+ hostname: 'github.com',
workspace,
singleCommit: false,
branch: 'no-pages',
@@ -138,6 +140,7 @@ describe('generateWorktree', () => {
const workspace = clonedir as string
await generateWorktree(
{
+ hostname: 'github.com',
workspace,
singleCommit: true,
branch: 'gh-pages',
@@ -169,6 +172,7 @@ describe('generateWorktree', () => {
const workspace = clonedir as string
await generateWorktree(
{
+ hostname: 'github.com',
workspace,
singleCommit: true,
branch: 'no-pages',
diff --git a/action.yml b/action.yml
index 8c1786c3..ed3f21a5 100644
--- a/action.yml
+++ b/action.yml
@@ -26,7 +26,7 @@ inputs:
We recommend using a service account with the least permissions neccersary
and when generating a new PAT that you select the least permission scopes required.
-
+
[Learn more about creating and using encrypted secrets here.](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
required: false
default: ${{ github.token }}
@@ -53,23 +53,23 @@ inputs:
default: true
clean-exclude:
- description: "If you need to use clean but you would like to preserve certain files or folders you can use this option. This should contain each pattern as a single line in a multiline string."
+ description: 'If you need to use clean but you would like to preserve certain files or folders you can use this option. This should contain each pattern as a single line in a multiline string.'
required: false
dry-run:
- description: "Do not actually push back, but use `--dry-run` on `git push` invocations insead."
+ description: 'Do not actually push back, but use `--dry-run` on `git push` invocations insead.'
required: false
git-config-name:
- description: "Allows you to customize the name that is attached to the GitHub config which is used when pushing the deployment commits. If this is not included it will use the name in the GitHub context, followed by the name of the action."
+ description: 'Allows you to customize the name that is attached to the GitHub config which is used when pushing the deployment commits. If this is not included it will use the name in the GitHub context, followed by the name of the action.'
required: false
git-config-email:
- description: "Allows you to customize the email that is attached to the GitHub config which is used when pushing the deployment commits. If this is not included it will use the email in the GitHub context, followed by a generic noreply GitHub email."
+ description: 'Allows you to customize the email that is attached to the GitHub config which is used when pushing the deployment commits. If this is not included it will use the email in the GitHub context, followed by a generic noreply GitHub email.'
required: false
repository-name:
- description: "Allows you to speicfy a different repository path so long as you have permissions to push to it. This should be formatted like so: JamesIves/github-pages-deploy-action"
+ description: 'Allows you to specify a different repository path so long as you have permissions to push to it. This should be formatted like so: JamesIves/github-pages-deploy-action'
required: false
workspace:
@@ -81,7 +81,7 @@ inputs:
required: false
silent:
- description: "Silences the action output preventing it from displaying git messages."
+ description: 'Silences the action output preventing it from displaying git messages.'
required: false
outputs:
diff --git a/assets/icon.png b/assets/icon.png
deleted file mode 100644
index f1b729fd..00000000
Binary files a/assets/icon.png and /dev/null differ
diff --git a/integration/.nojekyll b/integration/.nojekyll
new file mode 100644
index 00000000..8b137891
--- /dev/null
+++ b/integration/.nojekyll
@@ -0,0 +1 @@
+
diff --git a/package.json b/package.json
index 721e06df..f6ed2518 100644
--- a/package.json
+++ b/package.json
@@ -2,7 +2,7 @@
"name": "@jamesives/github-pages-deploy-action",
"description": "GitHub action for building a project and deploying it to GitHub pages.",
"author": "James Ives 
+ 