From 7d6bd779df84f73d0f88fbe15d28401421cd4263 Mon Sep 17 00:00:00 2001 From: James Ives Date: Sun, 3 Mar 2019 12:02:39 -0500 Subject: [PATCH 1/8] Valid color for the marketplace --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index a88c7cb3..a8174dd4 100644 --- a/Dockerfile +++ b/Dockerfile @@ -3,7 +3,7 @@ FROM node:10 LABEL "com.github.actions.name"="Deploy to Github Pages" LABEL "com.github.actions.description"="This action will handle the building and deploying process of your project to Github Pages." LABEL "com.github.actions.icon"="git-commit" -LABEL "com.github.actions.color"="#192022" +LABEL "com.github.actions.color"="orange" LABEL "repository"="http://github.com/JamesIves/gh-pages-github-action" LABEL "homepage"="http://github.com/JamesIves/gh-pages-gh-action" From 3f61a77a6ee838a8f8705850f2f357928bf5103e Mon Sep 17 00:00:00 2001 From: James Ives Date: Sun, 3 Mar 2019 12:05:51 -0500 Subject: [PATCH 2/8] Fixes :rocket: --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fb77b52c..ada27fc7 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ action "Deploy to Github Pages" { ## Configuration 📁 -The `env` portion of the workflow must be configured before the action will work. Below you'll find a description of each one does. +The `env` portion of the workflow must be configured before the action will work. Below you'll find a description of what each one does. | Key | Value Information | Required | | ------------- | ------------- | ------------- | From 81a7bf3c85b53fa23812f67a20ea510e483ae140 Mon Sep 17 00:00:00 2001 From: James Ives Date: Sun, 3 Mar 2019 12:10:31 -0500 Subject: [PATCH 3/8] Update entrypoint.sh --- entrypoint.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/entrypoint.sh b/entrypoint.sh index 1f90c1f1..c7c2911c 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -20,7 +20,7 @@ cd $GITHUB_WORKSPACE && \ # Configures Git and checks out the base branch. git config --global user.email "${COMMIT_EMAIL:-gh-pages-deploy@jives.dev}" && \ -git config --global user.name "${COMMIT_NAME:-Github Pages Deploy}" && \ +git config --global user.name "${COMMIT_NAME:-Github Pages Deployer}" && \ git checkout "${BASE_BRANCH:-master}" && \ # Builds the project if applicable. From 36b2b7a65aa5d06be9bf3e40b0fc7148e53bcf99 Mon Sep 17 00:00:00 2001 From: James Ives Date: Sun, 3 Mar 2019 12:10:55 -0500 Subject: [PATCH 4/8] Fixing up the README :rocket: --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ada27fc7..eba53e96 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # Github Pages Deploy Action :rocket: -This Github action will handle the building and deploying process of your project to Github pages. It can be configured to upload your production ready code into any branch you'd like, including `gh-pages` and `docs`. +This [Github action](https://github.com/features/actions) will handle the building and deploying 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: -Before you get started you must first create a fresh branch where the action will deploy the files to. You can replace `gh-pages` with whatever branch you'd like to use below. This will create a new orphaned branch which is what Github Pages require. +Before you get started you must first create a fresh branch where the action will deploy the files to. You can replace `gh-pages` with whatever branch you'd like to use in the example below. ```git git checkout --orphan gh-pages @@ -14,7 +14,7 @@ git commit -m 'Initial gh-pages commit' git push origin gh-pages ``` -Once setup you can then include the action in your workflow to trigger on any built in event that Github supports. +Once setup you can then include the action in your workflow to trigger on any event that [Github actions](https://github.com/features/actions) supports. ``` action "Deploy to Github Pages" { @@ -23,7 +23,7 @@ action "Deploy to Github Pages" { BUILD_SCRIPT = "npm install && npm run-script build" BRANCH = "gh-pages" FOLDER = "build" - COMMIT_EMAIL = "github-pages-deployer@jamesives.dev" + COMMIT_EMAIL = "github-pages-deployer@jives.dev" COMMIT_NAME = "Github Pages Deployer" } secrets = ["GITHUB_TOKEN"] @@ -32,15 +32,15 @@ action "Deploy to Github Pages" { ## Configuration 📁 -The `env` portion of the workflow must be configured before the action will work. Below you'll find a description of what each one does. +The `env` portion of the workflow **must** be configured before the action will work. Below you'll find a description of what each one does. | Key | Value Information | Required | | ------------- | ------------- | ------------- | -| `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 I'd suggest building the code prior to pushing it. | **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 building the code prior to pushing it to your base branch. | **No** | | `BRANCH` | This is the branch you wish to deploy to, for example `gh-pages` or `docs`. | **Yes** | | `BASE_BRANCH` | The base branch of your repository which you'd like to checkout prior to deploying. This defaults to `master`. | **No** | -| `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 in here. | **Yes** | -| `COMMIT_NAME` | Used to sign the commit, this should be your name. | **No** | -| `COMMIT_EMAIL` | Used to sign the commit, this should be your email. | **No** | +| `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. | **Yes** | +| `COMMIT_NAME` | Used to sign the commit, this should be your name. Defaults to `gh-pages-deploy@jives.dev` | **No** | +| `COMMIT_EMAIL` | Used to sign the commit, this should be your email. Defaults to `Github Pages Deployer` | **No** | ![Example](screenshot.png) From e58ef6c7024eff6f7f4cab1a4ce838ea35865898 Mon Sep 17 00:00:00 2001 From: James Ives Date: Sun, 3 Mar 2019 12:14:19 -0500 Subject: [PATCH 5/8] Action Badges :rocket: Adds badges to the action readme. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index eba53e96..f7232ace 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Github Pages Deploy Action :rocket: +[![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) + This [Github action](https://github.com/features/actions) will handle the building and deploying 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: From b586060fed8ef490701c1a1da79e315de3edacd4 Mon Sep 17 00:00:00 2001 From: James Ives Date: Sun, 3 Mar 2019 12:24:52 -0500 Subject: [PATCH 6/8] Adjusting action name --- Dockerfile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Dockerfile b/Dockerfile index a8174dd4..1c9344b5 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,7 +1,7 @@ FROM node:10 -LABEL "com.github.actions.name"="Deploy to Github Pages" -LABEL "com.github.actions.description"="This action will handle the building and deploying process of your project to Github Pages." +LABEL "com.github.actions.name"="Deploy to GitHub Pages" +LABEL "com.github.actions.description"="This action will handle the building and deploying process of your project to GitHub Pages." LABEL "com.github.actions.icon"="git-commit" LABEL "com.github.actions.color"="orange" From 3c179683fbe86d4ca68180c557a3f2ed83374847 Mon Sep 17 00:00:00 2001 From: James Ives Date: Sun, 3 Mar 2019 12:25:31 -0500 Subject: [PATCH 7/8] Update README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f7232ace..8949f226 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# Github Pages Deploy Action :rocket: +# GitHub Pages Deploy Action :rocket: [![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) -This [Github action](https://github.com/features/actions) will handle the building and deploying 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 [GitHub action](https://github.com/features/actions) will handle the building and deploying 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: Before you get started you must first create a fresh branch where the action will deploy the files to. You can replace `gh-pages` with whatever branch you'd like to use in the example below. @@ -16,17 +16,17 @@ git commit -m 'Initial gh-pages commit' git push origin gh-pages ``` -Once setup you can then include the action in your workflow to trigger on any event that [Github actions](https://github.com/features/actions) supports. +Once setup you can then include the action in your workflow to trigger on any event that [GitHub actions](https://github.com/features/actions) supports. ``` -action "Deploy to Github Pages" { +action "Deploy to GitHub Pages" { uses = "JamesIves/github-pages-deploy-action@master" env = { BUILD_SCRIPT = "npm install && npm run-script build" BRANCH = "gh-pages" FOLDER = "build" COMMIT_EMAIL = "github-pages-deployer@jives.dev" - COMMIT_NAME = "Github Pages Deployer" + COMMIT_NAME = "GitHub Pages Deployer" } secrets = ["GITHUB_TOKEN"] } @@ -43,6 +43,6 @@ The `env` portion of the workflow **must** be configured before the action will | `BASE_BRANCH` | The base branch of your repository which you'd like to checkout prior to deploying. This defaults to `master`. | **No** | | `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. | **Yes** | | `COMMIT_NAME` | Used to sign the commit, this should be your name. Defaults to `gh-pages-deploy@jives.dev` | **No** | -| `COMMIT_EMAIL` | Used to sign the commit, this should be your email. Defaults to `Github Pages Deployer` | **No** | +| `COMMIT_EMAIL` | Used to sign the commit, this should be your email. Defaults to `GitHub Pages Deployer` | **No** | ![Example](screenshot.png) From 157d0a2ef260ee4005126e965b72279a3a26b7eb Mon Sep 17 00:00:00 2001 From: James Ives Date: Sun, 3 Mar 2019 14:54:11 -0500 Subject: [PATCH 8/8] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8949f226..89bed8f4 100644 --- a/README.md +++ b/README.md @@ -38,11 +38,13 @@ The `env` portion of the workflow **must** be configured before the action will | Key | Value Information | Required | | ------------- | ------------- | ------------- | -| `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 building the code prior to pushing it to your base branch. | **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. | **No** | | `BRANCH` | This is the branch you wish to deploy to, for example `gh-pages` or `docs`. | **Yes** | | `BASE_BRANCH` | The base branch of your repository which you'd like to checkout prior to deploying. This defaults to `master`. | **No** | | `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. | **Yes** | | `COMMIT_NAME` | Used to sign the commit, this should be your name. Defaults to `gh-pages-deploy@jives.dev` | **No** | | `COMMIT_EMAIL` | Used to sign the commit, this should be your email. Defaults to `GitHub Pages Deployer` | **No** | +With the action correctly configured you should see something similar to this in your GitHub action workflow editor. + ![Example](screenshot.png)