This repository has been archived by the owner on Nov 21, 2023. It is now read-only.
forked from Li357/jekyll-deploy-gh-pages
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Converting to a simple docker image repo
- Loading branch information
Showing
12 changed files
with
17 additions
and
234 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1 @@ | ||
# A GitHub Action for Custom Jekyll Builds on GitHub Pages | ||
|
||
A GitHub Action for building and deploying a Jekyll repo back to its `gh-pages` branch. | ||
|
||
**Why not just let GitHub Pages build it? Because this way we can use our own custom Jekyll plugins and build scripts.** | ||
|
||
## Secrets | ||
* `GITHUB_TOKEN`: An access key which scoped to the repository - we need this to push the built site files back to the repo. This is generated for you on each workflow run——see usage in [example](#example). (GitHub Provides) | ||
|
||
## Environment Variables | ||
* `GITHUB_ACTOR`: Username of repo owner or object initiating the action (GitHub Provides) | ||
* `GITHUB_REPO`: Owner/Repository (GitHub Provides) | ||
|
||
## Example | ||
|
||
```yml | ||
name: Jekyll Deploy | ||
|
||
on: [push] | ||
|
||
jobs: | ||
build_and_deploy: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v1 | ||
- name: Build & Deploy to GitHub Pages | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
GITHUB_REPOSITORY: ${{ secrets.GITHUB_REPOSITORY }} | ||
GITHUB_ACTOR: ${{ secrets.GITHUB_ACTOR }} | ||
uses: faceleg/jekyll-deploy-gh-pages@master | ||
``` | ||
Clones the repo, builds the site, and commits it back to the `gh-pages` branch of the repository. That's it. Just add the above example to a `main.yml` file in the `.github/workflows` directory of your repository—see caveats below. | ||
|
||
## Caveats | ||
|
||
* `destination:` should be set to `./build` in your `_config.yml` file—as God demands. | ||
* A `Gemfile` is required. This must include `jekyll` and any other custom gems. | ||
# A Docker Image for Building GitHub Pages Static Sites with Custom Plugins |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.