adk23333/github-pages-deploy-action
1
0
Fork 0
mirror of https://github.com/JamesIves/github-pages-deploy-action.git synced 2023-12-15 20:03:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4 from JamesIves/check-exists

Browse Source 
Checks if remote exists
This commit is contained in:
James Ives 2019-03-04 11:35:03 -05:00 committed by GitHub
commit b113d69cdb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 25 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -5,18 +5,7 @@
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: ## 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. You can include the action in your workflow to trigger on any event that [GitHub actions](https://github.com/features/actions) supports. If the remote branch that you wish to deploy to doesn't already exist the action will create it for you.
```git
git checkout --orphan gh-pages
git rm -rf .
touch README.md
git add README.md
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.
```workflow ```workflow
action "Deploy to GitHub Pages" { action "Deploy to GitHub Pages" {
@ -30,7 +19,7 @@ action "Deploy to GitHub Pages" {
} }
``` ```
If you'd like to filter the action so it only triggers on a specific branch you can combine it with the filter action. You can find an example of this below. If you'd like you can combine it with the filter action so it only triggers deploys on a specific branch. You can find an example of this below.
```workflow ```workflow
workflow "Deploy to Github Pages" { workflow "Deploy to Github Pages" {

30
entrypoint.sh
View File

@ -28,9 +28,6 @@ then
COMMIT_NAME="${GITHUB_ACTOR}" COMMIT_NAME="${GITHUB_ACTOR}"
fi fi
## Initializes the repository path using the access token.
REPOSITORY_PATH="https://${ACCESS_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" && \
# Installs Git. # Installs Git.
apt-get update && \ apt-get update && \
apt-get install -y git && \ apt-get install -y git && \
@ -38,19 +35,38 @@ apt-get install -y git && \
# Directs the action to the the Github workspace. # Directs the action to the the Github workspace.
cd $GITHUB_WORKSPACE && \ cd $GITHUB_WORKSPACE && \
# Configures Git and checks out the base branch. # Configures Git.
git init && \ git init && \
git config --global user.email "${COMMIT_EMAIL}" && \ git config --global user.email "${COMMIT_EMAIL}" && \
git config --global user.name "${COMMIT_NAME}" && \ git config --global user.name "${COMMIT_NAME}" && \
## Initializes the repository path using the access token.
REPOSITORY_PATH="https://${ACCESS_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" && \
# Checks to see if the remote exists prior to deploying.
# If the branch doesn't exist it gets created here as an orphan.
if [ "$(git ls-remote --heads "$REPOSITORY_PATH" "$BRANCH" | wc -l)" -eq 0 ];
then
echo "Creating remote branch ${BRANCH} as it doesn't exist..."
git checkout "${BASE_BRANCH:-master}" && \
git checkout --orphan $BRANCH && \
git rm -rf . && \
touch README.md && \
git add README.md && \
git commit -m "Initial ${BRANCH} commit" && \
git push $REPOSITORY_PATH $BRANCH
fi
# Checks out the base branch to begin the deploy process.
git checkout "${BASE_BRANCH:-master}" && \ git checkout "${BASE_BRANCH:-master}" && \
# Builds the project if a build script is provided. # Builds the project if a build script is provided.
echo "Running build scripts... $BUILD_SCRIPT" echo "Running build scripts... $BUILD_SCRIPT" && \
eval "$BUILD_SCRIPT" eval "$BUILD_SCRIPT" && \
# Commits the data to Github. # Commits the data to Github.
echo "Deploying to GitHub..." && \ echo "Deploying to GitHub..." && \
git add -f $FOLDER && \ git add -f $FOLDER && \
git commit -m "Deploying to ${BRANCH} - $(date +"%T")" && \ git commit -m "Deploying to ${BRANCH} - $(date +"%T")" && \
git push $REPOSITORY_PATH `git subtree split --prefix $FOLDER master`:$BRANCH --force && \ git push $REPOSITORY_PATH `git subtree split --prefix $FOLDER master`:$BRANCH --force && \
echo "Deployment Succesful!" echo "Deployment succesful!"