Merge pull request #133 from actions/pin-release-draft-version

pin release draft version

.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      non-breaking-changes:
+        update-types: [minor, patch]
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      non-breaking-changes:
+        update-types: [minor, patch]

.github/release-drafter.yml

@@ -3,8 +3,10 @@ name-template: 'v$RESOLVED_VERSION'
 tag-template: 'v$RESOLVED_VERSION'
 template: |
   # Changelog
+
   $CHANGES
-  See details of [all code changes](https://github.com/actions/jekyll-build-pages/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION) since previous release
+
+  See details of [all code changes](https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION) since previous release.
 categories:
   - title: '🚀 Features'
     labels:

.github/workflows/docker-publish.yml

@@ -24,12 +24,12 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       # Login against a Docker registry except on PR
       # https://github.com/docker/login-action
       - name: Log into registry ${{ env.REGISTRY }}
-        uses: docker/login-action@v1
+        uses: docker/login-action@v3
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
@@ -43,25 +43,20 @@ jobs:
           else
             tags=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ github.ref_name }}
           fi
-          echo "::set-output name=tags::$tags"
+          echo "tags=$tags" >> $GITHUB_OUTPUT
       - name: Extract Docker metadata
         id: meta
-        uses: docker/metadata-action@v3
+        uses: docker/metadata-action@v5
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
 
       # Build and push Docker image with Buildx (don't push on PR)
       # https://github.com/docker/build-push-action
       - name: Build and push Docker image
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v6
         with:
           context: .
           file: Dockerfile
           push: true
           tags: ${{ steps.generate-image-tags.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
-      # Drafts your next Release notes as Pull Requests are merged into "main"
-      - uses: release-drafter/release-drafter@v5
-        if: github.ref_name == 'main'
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/draft-release.yml

@@ -0,0 +1,17 @@
+name: Draft release
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  draft-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: release-drafter/release-drafter@3f0f87098bd6b5c5b9a36d49c41d998ea58f9348
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/record.yml

@@ -16,12 +16,12 @@ jobs:
       tag: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.regex-match.outputs.group1 }}
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Grep action.yaml content
         id: grep-image-content
         run: |
           image=$(grep -E "jekyll-build-pages.*\'" action.yml)
-          echo "::set-output name=image::$image"
+          echo "image=$image" >> $GITHUB_OUTPUT
       - uses: actions-ecosystem/action-regex-match@v2
         id: regex-match
         with:
@@ -44,9 +44,9 @@ jobs:
           - future-true
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Build local docker image
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v6
         with:
           context: .
           file: Dockerfile
@@ -61,7 +61,7 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Archive ${{ matrix.test }} Project
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ matrix.test }}
           path: ./test_projects/${{ matrix.test }}/_expected

.github/workflows/release.yml

@@ -1,11 +1,11 @@
-name: Release new action version
+name: Release
 on:
   release:
-    types: [edited]
+    types: [released]
   workflow_dispatch:
     inputs:
       TAG_NAME:
-        description: 'Tag name that the major tag will point to'
+        description: "Tag name that the major tag will point to"
         required: true
 
 env:
@@ -13,17 +13,20 @@ env:
   REGISTRY: ghcr.io
   IMAGE_NAME: ${{ github.repository }}
 
+permissions:
+  contents: write
+
 jobs:
   verify_release:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Grep action.yaml content
         id: grep-image-content
         run: |
           image=$(grep -E "jekyll-build-pages.*\'" action.yml)
-          echo "::set-output name=image::$image"
+          echo "image=$image" >> $GITHUB_OUTPUT
       - uses: actions-ecosystem/action-regex-match@v2
         id: regex-match
         with:
@@ -37,18 +40,19 @@ jobs:
           fi
       - name: Verify image published
         run: docker pull ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ env.TAG_NAME }}
+
   update_tag:
     needs: verify_release
     name: Update the major tag to include the ${{ github.event.inputs.TAG_NAME || github.event.release.tag_name }} changes
     environment:
-      name: releaseNewActionVersion
+      # Note: this environment is protected
+      name: Release
     runs-on: ubuntu-latest
     outputs:
       major_tag: ${{ steps.update-major-tag.outputs.major-tag }}
     steps:
-    - name: Update the ${{ env.TAG_NAME }} tag
-      id: update-major-tag
-      uses: actions/publish-action@v0.1.0
-      with:
-        source-tag: ${{ env.TAG_NAME }}
-        slack-webhook: ${{ secrets.SLACK_WEBHOOK }}
+      - name: Update the ${{ env.TAG_NAME }} major tag
+        id: update-major-tag
+        uses: actions/publish-action@v0.3.0
+        with:
+          source-tag: ${{ env.TAG_NAME }}

.github/workflows/shellcheck.yml

@@ -4,6 +4,8 @@ on:
   pull_request:
     paths:
       - '**.sh'
+      # this is too wide but will cover shell scripts without an extension in that folder
+      - 'bin/*'
 
 jobs:
   shellcheck:
@@ -12,7 +14,7 @@ jobs:
       SHELLCHECK_OPTS: -s bash
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Run ShellCheck
         uses: ludeeus/action-shellcheck@master

.github/workflows/test.yml

@@ -4,11 +4,7 @@ on:
   push:
     branches:
       - main
-    paths-ignore:
-      - "README.md"
   pull_request:
-    paths-ignore:
-      - "README.md"
 env:
   # Use docker.io for Docker Hub if empty
   REGISTRY: ghcr.io
@@ -22,12 +18,12 @@ jobs:
       tag: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.regex-match.outputs.group1 }}
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Grep action.yaml content
         id: grep-image-content
         run: |
           image=$(grep -E "jekyll-build-pages.*\'" action.yml)
-          echo "::set-output name=image::$image"
+          echo "image=$image" >> $GITHUB_OUTPUT
       - uses: actions-ecosystem/action-regex-match@v2
         id: regex-match
         with:
@@ -50,9 +46,9 @@ jobs:
           - future-true
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Build local docker image
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v6
         with:
           context: .
           file: Dockerfile

Dockerfile

@@ -1,4 +1,4 @@
-ARG RUBY_VERSION=2.7.4
+ARG RUBY_VERSION=3.3
 FROM ruby:$RUBY_VERSION-slim
 
 RUN apt-get update \
@@ -22,4 +22,3 @@ ENV LC_ALL en_US.UTF-8
 COPY entrypoint.sh /entrypoint.sh
 
 ENTRYPOINT ["/entrypoint.sh"]
-

Gemfile

@@ -5,7 +5,7 @@ source "https://rubygems.org"
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Manage our dependency on the version of the github-pages gem here.
-gem "github-pages", "= 227"
+gem "github-pages", "= 232"
 
 # Explicitly include this gem here.
 # It is not directly included in the github-pages gem list of dependencies,

README.md

@@ -1,15 +1,102 @@
-# Jekyll-Build-Pages
+# jekyll-build-pages
 
 A simple GitHub Action for producing Jekyll build artifacts compatible with GitHub Pages.
 
-# Scope
+## Scope
 
 This is used along with [`actions/deploy-pages`](https://github.com/actions/deploy-pages) as part of the official support for building Pages with Actions (currently in public beta for public repositories).
 
-# Usage
+## Usage
 
-See [action.yml](action.yml)
+A basic Pages deployment workflow with the `jekyll-build-pages` action looks like this.
 
-# License
+```yaml
+name: Build Jekyll site
+on:
+ push:
+   branches: ["main"]
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Build
+        uses: actions/jekyll-build-pages@v1
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+```
+
+To write to a different destination directory, match the inputs of both the `jekyll-build-pages` and [`upload-pages-artifact`](https://github.com/actions/upload-pages-artifact) actions.
+
+```yaml
+steps:
+  - name: Build
+    uses: actions/jekyll-build-pages@v1
+    with:
+      destination: "./output"
+  - name: Upload artifact
+    uses: actions/upload-pages-artifact@v3
+    with:
+      path: "./output"
+```
+
+### Action inputs
+
+| Input | Default | Description |
+|-------|---------|-------------|
+| `source` | `./` | The directory to build from |
+| `destination` | `./_site` | The directory to write output into<br>(this should match the `path` input of the [`actions/upload-pages-artifact`](https://github.com/actions/upload-pages-artifact) action) |
+| `future` | `false` | If `true`, writes content dated in the future |
+| `build_revision` | `$GITHUB_SHA` | The SHA-1 of the Git commit for which the build is running |
+| `verbose` | `false` | If `true`, prints verbose output in logs |
+| `token` | `$GITHUB_TOKEN` | The GitHub token used to authenticate API requests |
+
+## Release instructions
+
+In order to release a new version of this Action:
+
+1. Locate the semantic version of the [upcoming release][release-list] (a draft is maintained by the [`draft-release` workflow][draft-release]).
+
+2. Prepare a pull request to update [`action.yml`][action.yml] to reference the incoming version, get it approved, and merge it into the `main` branch.
+
+3. Publish the draft release **as a pre-release** from the `main` branch with semantic version as the tag name, _with_:
+   - the checkbox to publish to the GitHub Marketplace checked :ballot_box_with_check:
+   - :warning: _AND_ the checkbox to **Set as a pre-release** checked. :ballot_box_with_check:
+
+4. This will kick off a [Docker publishing workflow][docker-publish] for the newly created tag. Check the [associated workflow run list][docker-publish-workflow-runs] to verify the new Docker image is created successfully before moving on to the next step.
+
+5. After the Docker image has been created with the new tag, find that [same pre-release][release-list] and edit it. Update it with the checkbox to **Set as the latest release** checked :ballot_box_with_check: and then publish it again.
+
+6. After publishing it as the latest release, the [`release` workflow][release] will automatically run to create/update the corresponding the major version tag such as `v1`.
+
+   ⚠️ Environment approval is required. Check the [Release workflow run list][release-workflow-runs].
+
+## License
 
 The scripts and documentation in this project are released under the [MIT License](LICENSE).
+
+<!-- references -->
+[release-list]: https://github.com/actions/jekyll-build-pages/releases
+[draft-release]: .github/workflows/draft-release.yml
+[docker-publish]: .github/workflows/docker-publish.yml
+[release]: .github/workflows/release.yml
+[docker-publish-workflow-runs]: https://github.com/actions/jekyll-build-pages/actions/workflows/docker-publish.yml
+[release-workflow-runs]: https://github.com/actions/jekyll-build-pages/actions/workflows/release.yml
+[action.yml]: https://github.com/actions/jekyll-build-pages/blob/649f5d3c2b2462620c8945f034200e431ceddd29/action.yml#LL31C54-L31C60

action.yml

@@ -28,4 +28,4 @@ inputs:
     default: ${{ github.token }}
 runs:
   using: 'docker'
-  image: 'docker://ghcr.io/actions/jekyll-build-pages:v1.0.4'
+  image: 'docker://ghcr.io/actions/jekyll-build-pages:v1.0.13'

bin/record_expected_output

@@ -5,9 +5,9 @@ if [ "local" = "$1" ]; then
   export PAGES_REPO_NWO=actions/jekyll-build-pages
   export JEKYLL_BUILD_REVISION=JEKYLL_BUILD_REVISION
 
-  for dir in $(ls test_projects)
+  for dir in test_projects/*
   do
-    bundle exec github-pages build --verbose -s test_projects/$dir -d test_projects/$dir/_expected
+    bundle exec github-pages build --verbose -s "test_projects/${dir}" -d "test_projects/${dir}/_expected"
   done
 else
   act -b -s GITHUB_TOKEN -j record-expected-output

entrypoint.sh

@@ -1,23 +1,27 @@
 #!/bin/bash
 
-#######################################################################################################
+####################################################################################################
 #
-# Calls github-pages executable to build the site using whitelisted plugins and supported configuration
+# Calls github-pages executable to build the site using allowed plugins and supported configuration
 #
-#######################################################################################################
-
-set -o errexit
+####################################################################################################
 
 SOURCE_DIRECTORY=${GITHUB_WORKSPACE}/$INPUT_SOURCE
 DESTINATION_DIRECTORY=${GITHUB_WORKSPACE}/$INPUT_DESTINATION
 PAGES_GEM_HOME=$BUNDLE_APP_CONFIG
-GITHUB_PAGES=$PAGES_GEM_HOME/bin/github-pages
+GITHUB_PAGES_BIN=$PAGES_GEM_HOME/bin/github-pages
+
+# Check if Gemfile's dependencies are satisfied or print a warning
+if test -e "$SOURCE_DIRECTORY/Gemfile" && ! bundle check --dry-run --gemfile "$SOURCE_DIRECTORY/Gemfile"; then
+  echo "::warning::The github-pages gem can't satisfy your Gemfile's dependencies. If you want to use a different Jekyll version or need additional dependencies, consider building Jekyll site with GitHub Actions: https://jekyllrb.com/docs/continuous-integration/github-actions/"
+fi
 
 # Set environment variables required by supported plugins
 export JEKYLL_ENV="production"
 export JEKYLL_GITHUB_TOKEN=$INPUT_TOKEN
 export PAGES_REPO_NWO=$GITHUB_REPOSITORY
 export JEKYLL_BUILD_REVISION=$INPUT_BUILD_REVISION
+export PAGES_API_URL=$GITHUB_API_URL
 
 # Set verbose flag
 if [ "$INPUT_VERBOSE" = 'true' ]; then
@@ -33,5 +37,22 @@ else
   FUTURE=''
 fi
 
-cd "$PAGES_GEM_HOME"
-$GITHUB_PAGES build "$VERBOSE" "$FUTURE" --source "$SOURCE_DIRECTORY" --destination "$DESTINATION_DIRECTORY"
+{ cd "$PAGES_GEM_HOME" || { echo "::error::pages gem not found"; exit 1; }; }
+
+# Run the command, capturing the output
+build_output="$($GITHUB_PAGES_BIN build "$VERBOSE" "$FUTURE" --source "$SOURCE_DIRECTORY" --destination "$DESTINATION_DIRECTORY")"
+
+# Capture the exit code
+exit_code=$?
+
+if [ $exit_code -ne 0 ]; then
+  # Remove the newlines from the build_output as annotation not support multiline
+  error=$(echo "$build_output" | tr '\n' ' ' | tr -s ' ')
+  echo "::error::$error"
+else
+  # Display the build_output directly
+  echo "$build_output"
+fi
+
+# Exit with the captured exit code
+exit $exit_code

test_projects/future-false/_expected/2020/02/13/the-future-is-looking-bright.html

@@ -7,7 +7,7 @@
 
 <!-- Begin Jekyll SEO tag v2.8.0 -->
 <title>The Future is Looking Bright! | jekyll-build-pages</title>
-<meta name="generator" content="Jekyll v3.9.2" />
+<meta name="generator" content="Jekyll v3.10.0" />
 <meta property="og:title" content="The Future is Looking Bright!" />
 <meta property="og:locale" content="en_US" />
 <meta name="description" content="Everything’s coming up Milhouse." />

test_projects/future-true/_expected/2020/02/13/the-future-is-looking-bright.html

@@ -7,7 +7,7 @@
 
 <!-- Begin Jekyll SEO tag v2.8.0 -->
 <title>The Future is Looking Bright! | jekyll-build-pages</title>
-<meta name="generator" content="Jekyll v3.9.2" />
+<meta name="generator" content="Jekyll v3.10.0" />
 <meta property="og:title" content="The Future is Looking Bright!" />
 <meta property="og:locale" content="en_US" />
 <meta name="description" content="Everything’s coming up Milhouse." />

test_projects/future-true/_expected/2022/03/01/we-live-in-hell.html

@@ -7,7 +7,7 @@
 
 <!-- Begin Jekyll SEO tag v2.8.0 -->
 <title>We Live In Hell | jekyll-build-pages</title>
-<meta name="generator" content="Jekyll v3.9.2" />
+<meta name="generator" content="Jekyll v3.10.0" />
 <meta property="og:title" content="We Live In Hell" />
 <meta property="og:locale" content="en_US" />
 <meta name="description" content="And it’s not even the cool hell that [redacted] are afraid of. 😭" />

test_projects/jekyll-include-cache/_expected/index.html

@@ -7,7 +7,7 @@
 
 <!-- Begin Jekyll SEO tag v2.8.0 -->
 <title>jekyll-build-pages | A simple GitHub Action for producing Jekyll build artifacts compatible with GitHub Pages.</title>
-<meta name="generator" content="Jekyll v3.9.2" />
+<meta name="generator" content="Jekyll v3.10.0" />
 <meta property="og:title" content="jekyll-build-pages" />
 <meta property="og:locale" content="en_US" />
 <meta name="description" content="A simple GitHub Action for producing Jekyll build artifacts compatible with GitHub Pages." />

test_projects/mojombo/Gemfile.lock

@@ -103,20 +103,20 @@ GEM
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9.7)
     mercenary (0.3.6)
-    mini_portile2 (2.8.0)
+    mini_portile2 (2.8.5)
     minima (2.0.0)
     minitest (5.9.1)
     multipart-post (2.0.0)
     net-dns (0.8.0)
-    nokogiri (1.13.6)
-      mini_portile2 (~> 2.8.0)
+    nokogiri (1.16.2)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     octokit (4.6.0)
       sawyer (~> 0.8.0, >= 0.5.3)
     pathutil (0.14.0)
       forwardable-extended (~> 2.6)
     public_suffix (1.5.3)
-    racc (1.6.0)
+    racc (1.7.3)
     rb-fsevent (0.9.8)
     rb-inotify (0.9.7)
       ffi (>= 0.5.0)

test_projects/mojombo/_expected/atom.xml

@@ -881,8 +881,8 @@ format. You can find the full spec at <a href="http://tomdoc.org"&g
 <span class="c1">#</span>
 <span class="c1"># Examples</span>
 <span class="c1">#</span>
-<span class="c1">#   multiplex('Tom', 4)</span>
-<span class="c1">#   # => 'TomTomTomTom'</span>
+<span class="c1">#   multiplex('Tom', 4)</span>
+<span class="c1">#   # => 'TomTomTomTom'</span>
 <span class="c1">#</span>
 <span class="c1"># Returns the duplicated String.</span>
 <span class="k">def</span> <span class="nf">multiplex</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">count</span><span class="p">)</span>

test_projects/octicons/_expected/index.html

@@ -7,7 +7,7 @@
 
 <!-- Begin Jekyll SEO tag v2.8.0 -->
 <title>Readme Test | jekyll-build-pages</title>
-<meta name="generator" content="Jekyll v3.9.2" />
+<meta name="generator" content="Jekyll v3.10.0" />
 <meta property="og:title" content="Readme Test" />
 <meta property="og:locale" content="en_US" />
 <meta name="description" content="A simple GitHub Action for producing Jekyll build artifacts compatible with GitHub Pages." />

test_projects/readme/_expected/index.html

@@ -7,7 +7,7 @@
 
 <!-- Begin Jekyll SEO tag v2.8.0 -->
 <title>Readme Test | jekyll-build-pages</title>
-<meta name="generator" content="Jekyll v3.9.2" />
+<meta name="generator" content="Jekyll v3.10.0" />
 <meta property="og:title" content="Readme Test" />
 <meta property="og:locale" content="en_US" />
 <meta name="description" content="A simple GitHub Action for producing Jekyll build artifacts compatible with GitHub Pages." />

test_projects/simple/_expected/index.html

@@ -7,7 +7,7 @@
 
 <!-- Begin Jekyll SEO tag v2.8.0 -->
 <title>Jekyll Actions Demo | A simple GitHub Action for producing Jekyll build artifacts compatible with GitHub Pages.</title>
-<meta name="generator" content="Jekyll v3.9.2" />
+<meta name="generator" content="Jekyll v3.10.0" />
 <meta property="og:title" content="Jekyll Actions Demo" />
 <meta property="og:locale" content="en_US" />
 <meta name="description" content="A simple GitHub Action for producing Jekyll build artifacts compatible with GitHub Pages." />

test_projects/themes/_expected/index.html

@@ -7,7 +7,7 @@
 
 <!-- Begin Jekyll SEO tag v2.8.0 -->
 <title>themes | A simple GitHub Action for producing Jekyll build artifacts compatible with GitHub Pages.</title>
-<meta name="generator" content="Jekyll v3.9.2" />
+<meta name="generator" content="Jekyll v3.10.0" />
 <meta property="og:title" content="themes" />
 <meta property="og:locale" content="en_US" />
 <meta name="description" content="A simple GitHub Action for producing Jekyll build artifacts compatible with GitHub Pages." />