Skip to content

Commit afdad0e

Browse files
Create jekyll-gh-pages.yml
As a devx developer I want to publish GH Pages for several repositories. The [gh pages documentation](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages) is detailed. The following key points contributed to my decision to add this change: * Currently there a 2 ways to generate GH Pages on a repository. The documentation calls these "sources". One is a manual push; the other uses a special github action deployment workflow. * After June 2024, only the github action source will be used. * Best practice around documentation is that (1) a special github "environment" should be created called "github-pages" and (2) a unique branch "gh-pages" should be created alongside the "main". The environment is a set of rules that limits documentation deployments from specific branches and the unique branch means that "code" and site-documentation are kept separate. Therefore, I created the github-pages environment, the gh-pages branch, and the github action workflow defined in this PR
1 parent cbd6f81 commit afdad0e

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

.github/workflows/jekyll-gh-pages.yml

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
2+
name: Deploy Jekyll with GitHub Pages dependencies preinstalled
3+
4+
on:
5+
# Runs on pushes targeting the default branch
6+
push:
7+
branches: ["main"]
8+
9+
# Allows you to run this workflow manually from the Actions tab
10+
workflow_dispatch:
11+
12+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
19+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
20+
concurrency:
21+
group: "pages"
22+
cancel-in-progress: false
23+
24+
jobs:
25+
# Build job
26+
build:
27+
runs-on: ubuntu-latest
28+
steps:
29+
- name: Checkout
30+
uses: actions/checkout@v4
31+
- name: Setup Pages
32+
uses: actions/configure-pages@v5
33+
- name: Build with Jekyll
34+
uses: actions/jekyll-build-pages@v1
35+
with:
36+
source: ./
37+
destination: ./_site
38+
- name: Upload artifact
39+
uses: actions/upload-pages-artifact@v3
40+
41+
# Deployment job
42+
deploy:
43+
environment:
44+
name: github-pages
45+
url: ${{ steps.deployment.outputs.page_url }}
46+
runs-on: ubuntu-latest
47+
needs: build
48+
steps:
49+
- name: Deploy to GitHub Pages
50+
id: deployment
51+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)