dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update guide 

- use latest versions
- link to https://github.com/limjh16/jekyll-action-ts
This commit is contained in:
Frank Taillandier 2021-01-07 16:17:23 +01:00 committed by GitHub
parent 03712b0188
commit 31e152b0d0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/_docs/continuous-integration/github-actions.md
View File

@ -12,7 +12,7 @@ with GitHub Pages you can use GitHub Actions.
### Control over gemset ### Control over gemset
- **Jekyll version** --- Instead of using the currently enabled version at `3.9.0`, you can use any - **Jekyll version** --- Instead of using the currently enabled version at `3.9.0`, you can use any
version of Jekyll you want. For example `4.0.0`, or point directly to the repository. version of Jekyll you want. For example `{{site.version}}`, or point directly to the repository.
- **Plugins** --- You can use any Jekyll plugins irrespective of them being on the - **Plugins** --- You can use any Jekyll plugins irrespective of them being on the
[supported versions][ghp-whitelist] list, even `*.rb` files placed in the `_plugins` directory [supported versions][ghp-whitelist] list, even `*.rb` files placed in the `_plugins` directory
of your site. of your site.
@ -29,7 +29,7 @@ with GitHub Pages you can use GitHub Actions.
## Workspace setup ## Workspace setup
The first and foremost requirement is a Jekyll project hosted at GitHub. Choose an existing Jekyll The first and foremost requirement is a Jekyll project hosted at GitHub. Choose an existing Jekyll
project or follow the [Quickstart]({{ '/docs' | relative_url }}) and push the repository to GitHub project or follow the [quickstart]({{ '/docs' | relative_url }}) and push the repository to GitHub
if it is not hosted there already. if it is not hosted there already.
We're only going to cover builds from the `master` branch in this page. Therefore, ensure that you We're only going to cover builds from the `master` branch in this page. Therefore, ensure that you
@ -72,7 +72,7 @@ Welcome to My Home Page
source 'https://rubygems.org' source 'https://rubygems.org'
gem 'jekyll', '~> 4.0' gem 'jekyll', '~> 4.2'
group :jekyll_plugins do group :jekyll_plugins do
gem 'jekyll-timeago', '~> 0.13.1' gem 'jekyll-timeago', '~> 0.13.1'
@ -110,10 +110,10 @@ on:
jobs: jobs:
github-pages: github-pages:
runs-on: ubuntu-16.04 runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- uses: helaili/jekyll-action@2.0.1 - uses: helaili/jekyll-action@2.0.5
env: env:
JEKYLL_PAT: ${{ secrets.JEKYLL_PAT }} JEKYLL_PAT: ${{ secrets.JEKYLL_PAT }}
``` ```
@ -125,7 +125,7 @@ The above workflow can be explained as the following:
the Action from overwriting the `gh-pages` branch on any feature branch pushes. the Action from overwriting the `gh-pages` branch on any feature branch pushes.
- The **name** of the job matches our YAML filename: `github-pages`. - The **name** of the job matches our YAML filename: `github-pages`.
- The **checkout** action takes care of cloning your repository. - The **checkout** action takes care of cloning your repository.
- We specify our selected **action** and **version number** using `helaili/jekyll-action@2.0.0`. - We specify our selected **action** and **version number** using `helaili/jekyll-action@2.0.5`.
This handles the build and deploy. This handles the build and deploy.
- We set a reference to a secret **environment variable** for the action to use. The `JEKYLL_PAT` - We set a reference to a secret **environment variable** for the action to use. The `JEKYLL_PAT`
is a *Personal Access Token* and is detailed in the next section. is a *Personal Access Token* and is detailed in the next section.
@ -204,10 +204,11 @@ successful deploy from the Action.
- [jekyll-actions] is an action available on the GitHub Marketplace and was used in this guide. - [jekyll-actions] is an action available on the GitHub Marketplace and was used in this guide.
- [jekyll-actions-quickstart] is an unofficial repository that includes a live demo of the - [jekyll-actions-quickstart] is an unofficial repository that includes a live demo of the
`jekyll-actions` action. That project can be used as a template for making a new site. `jekyll-actions` action. That project can be used as a template for making a new site.
- [jekyll-action-ts] is another action to build and publish Jekyll sites on GiHub Pages that includes HTML formatting options wih Prettier and caching.
[ghp-whitelist]: https://pages.github.com/versions/ [ghp-whitelist]: https://pages.github.com/versions/
[timeago-plugin]: https://rubygems.org/gems/jekyll-timeago [timeago-plugin]: https://rubygems.org/gems/jekyll-timeago
[tokens]: https://github.com/settings/tokens [tokens]: https://github.com/settings/tokens
[jekyll-actions]: https://github.com/marketplace/actions/jekyll-actions [jekyll-actions]: https://github.com/marketplace/actions/jekyll-actions
[jekyll-actions-quickstart]: https://github.com/MichaelCurrin/jekyll-actions-quickstart [jekyll-actions-quickstart]: https://github.com/MichaelCurrin/jekyll-actions-quickstart
[jekyll-action-ts]: https://github.com/limjh16/jekyll-action-ts