Merge pull request #129 from actions/prep-release

Prep release of v1.0.13

.github/dependabot.yml

@@ -4,8 +4,14 @@ updates:
     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/workflows/docker-publish.yml

@@ -24,12 +24,12 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        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@v2
+        uses: docker/login-action@v3
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
@@ -46,14 +46,14 @@ jobs:
           echo "tags=$tags" >> $GITHUB_OUTPUT
       - name: Extract Docker metadata
         id: meta
-        uses: docker/metadata-action@v4
+        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@v4
+        uses: docker/build-push-action@v6
         with:
           context: .
           file: Dockerfile

.github/workflows/draft-release.yml

@@ -11,7 +11,7 @@ jobs:
   draft-release:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: release-drafter/release-drafter@v5
+      - uses: actions/checkout@v4
+      - uses: release-drafter/release-drafter@v6
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/record.yml

@@ -16,7 +16,7 @@ jobs:
       tag: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.regex-match.outputs.group1 }}
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Grep action.yaml content
         id: grep-image-content
         run: |
@@ -44,9 +44,9 @@ jobs:
           - future-true
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Build local docker image
-        uses: docker/build-push-action@v4
+        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

@@ -21,7 +21,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Grep action.yaml content
         id: grep-image-content
         run: |
@@ -53,21 +53,6 @@ jobs:
     steps:
       - name: Update the ${{ env.TAG_NAME }} major tag
         id: update-major-tag
-        uses: actions/publish-action@v0.2.2
+        uses: actions/publish-action@v0.3.0
         with:
           source-tag: ${{ env.TAG_NAME }}
-
-      # Login to the GHCR Docker registry
-      - name: Log into registry ${{ env.REGISTRY }}
-        uses: docker/login-action@v2
-        with:
-          registry: ${{ env.REGISTRY }}
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Update Docker image tag
-        env:
-          NEW_TAG: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.update-major-tag.outputs.major-tag }}
-          SOURCE_TAG: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ env.TAG_NAME }}
-        run: |
-          docker buildx imagetools create --tag $NEW_TAG $SOURCE_TAG

.github/workflows/shellcheck.yml

@@ -14,7 +14,7 @@ jobs:
       SHELLCHECK_OPTS: -s bash
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Run ShellCheck
         uses: ludeeus/action-shellcheck@master

.github/workflows/test.yml

@@ -18,7 +18,7 @@ jobs:
       tag: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.regex-match.outputs.group1 }}
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Grep action.yaml content
         id: grep-image-content
         run: |
@@ -46,9 +46,9 @@ jobs:
           - future-true
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Build local docker image
-        uses: docker/build-push-action@v4
+        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", "= 228"
+gem "github-pages", "= 232"
 
 # Explicitly include this gem here.
 # It is not directly included in the github-pages gem list of dependencies,

README.md

@@ -24,20 +24,20 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Pages
-        uses: actions/configure-pages@v3
+        uses: actions/configure-pages@v5
       - name: Build
         uses: actions/jekyll-build-pages@v1
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
+        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@v2
+        uses: actions/deploy-pages@v4
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
@@ -52,7 +52,7 @@ steps:
     with:
       destination: "./output"
   - name: Upload artifact
-    uses: actions/upload-pages-artifact@v1
+    uses: actions/upload-pages-artifact@v3
     with:
       path: "./output"
 ```
@@ -74,11 +74,17 @@ 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
+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 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:
+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. After publishing the release, the [`release` workflow][release] will automatically run to create/update the corresponding the major version tag such as `v1`.
+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].
 
@@ -88,7 +94,9 @@ The scripts and documentation in this project are released under the [MIT Licens
 
 <!-- references -->
 [release-list]: https://github.com/actions/jekyll-build-pages/releases
-[draft-release]: .github/workflows/release.yml
+[draft-release]: .github/workflows/draft-release.yml
+[docker-publish]: .github/workflows/docker-publish.yml
 [release]: .github/workflows/release.yml
-[release-workflow-runs]: https://github.com/actions/deploy-pages/actions/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.8'
+  image: 'docker://ghcr.io/actions/jekyll-build-pages:v1.0.13'

entrypoint.sh

@@ -6,8 +6,6 @@
 #
 ####################################################################################################
 
-set -o errexit
-
 SOURCE_DIRECTORY=${GITHUB_WORKSPACE}/$INPUT_SOURCE
 DESTINATION_DIRECTORY=${GITHUB_WORKSPACE}/$INPUT_DESTINATION
 PAGES_GEM_HOME=$BUNDLE_APP_CONFIG
@@ -15,7 +13,7 @@ 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:: github-pages can't satisfy your Gemfile's dependencies."
+  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
@@ -39,5 +37,22 @@ else
   FUTURE=''
 fi
 
-cd "$PAGES_GEM_HOME"
-$GITHUB_PAGES_BIN 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.3" />
+<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.3" />
+<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.3" />
+<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.3" />
+<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,12 +103,12 @@ GEM
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9.7)
     mercenary (0.3.6)
-    mini_portile2 (2.8.2)
+    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.15.2)
+    nokogiri (1.16.2)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     octokit (4.6.0)
@@ -116,7 +116,7 @@ GEM
     pathutil (0.14.0)
       forwardable-extended (~> 2.6)
     public_suffix (1.5.3)
-    racc (1.7.1)
+    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.3" />
+<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.3" />
+<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.3" />
+<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.3" />
+<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." />