Merge pull request #94 from SilverRainZ/main

Group tar's output to prevent it from messing up action logs

.github/dependabot.yml

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

.github/workflows/draft-release.yml

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

.github/workflows/release.yml

@@ -24,7 +24,7 @@ jobs:
     steps:
       - name: Update the ${{ env.TAG_NAME }} tag
         id: update-major-tag
-        uses: actions/publish-action@v0.1.0
+        uses: actions/publish-action@v0.3.0
         with:
           source-tag: ${{ env.TAG_NAME }}
           slack-webhook: ${{ secrets.SLACK_WEBHOOK }}

.github/workflows/test-hosted-runners.yml

@@ -22,7 +22,7 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Generate files
       run: mkdir artifact && mkdir artifact2 && cd artifact && ../script/new-artifact.sh
@@ -31,12 +31,13 @@ jobs:
     - name: Upload Pages artifact
       uses: ./
       with:
+        name: pages-artifact-${{ matrix.os }}
         path: artifact
 
     - name: Download artifact
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
-          name: github-pages
+          name: pages-artifact-${{ matrix.os }}
           path: artifact2
 
     - name: Extract artifact

README.md

@@ -2,17 +2,17 @@
 
 A composite Action for packaging and uploading artifact that can be deployed to [GitHub Pages][pages].
 
-# Scope
+## Scope
 
 ⚠️ Official support for building Pages with Actions is in public beta at the moment.
 
-# Usage
+## Usage
 
 See [action.yml](action.yml)
 
 <!-- TODO: document custom workflow -->
 
-# Artifact validation
+## Artifact validation
 
 While using this action is optional, we highly recommend it since it takes care of producing (mostly) valid artifacts.
 
@@ -25,8 +25,48 @@ The [`tar` file][tar] must:
 
 - be under 10GB in size
 - not contain any symbolic or hard links
+- contain only files and directories that all meet the expected minimum [file permissions](#file-permissions)
 
-# Release instructions
+### File permissions
+
+When using this action, ensure that your files have appropriate file permissions.
+At a minimum, GitHub Pages expects:
+- files to have read permission for the current user and the "Others" user role (e.g. `0744`, `0644`, `0444`)
+- directories to have read and execute permissions for the current user and the "Others" user role (e.g. `0755`, `0555`)
+
+Failure to supply adequate permissions will result in a `deployment_perms_error` when attempting to deploy your artifacts to GitHub Pages.
+
+#### Example permissions fix for Linux
+
+```yaml
+steps:
+# ...
+  - name: Fix permissions
+    run: |
+      chmod -c -R +rX "_site/" | while read line; do
+        echo "::warning title=Invalid file permissions automatically fixed::$line"
+      done
+  - name: Upload Pages artifact
+    uses: actions/upload-pages-artifact@v3
+# ...
+```
+
+#### Example permissions fix for Mac
+
+```yaml
+steps:
+# ...
+  - name: Fix permissions
+    run: |
+      chmod -v -R +rX "_site/" | while read line; do
+        echo "::warning title=Invalid file permissions automatically fixed::$line"
+      done
+  - name: Upload Pages artifact
+    uses: actions/upload-pages-artifact@v3
+# ...
+```
+
+## Release instructions
 
 In order to release a new version of this Action:
 
@@ -38,15 +78,15 @@ In order to release a new version of this Action:
 
    ⚠️ Environment approval is required. Check the [Release workflow run list][release-workflow-runs].
 
-# License
+## License
 
 The scripts and documentation in this project are released under the [MIT License](LICENSE).
 
 <!-- references -->
 [pages]: https://pages.github.com
-[release-list]: /releases
+[release-list]: https://github.com/actions/upload-pages-artifact/releases
 [draft-release]: .github/workflows/draft-release.yml
 [release]: .github/workflows/release.yml
-[release-workflow-runs]: /actions/workflows/release.yml
+[release-workflow-runs]: https://github.com/actions/upload-pages-artifact/actions/workflows/release.yml
 [gzip]: https://en.wikipedia.org/wiki/Gzip
 [tar]: https://en.wikipedia.org/wiki/Tar_(computing)

action.yml

@@ -2,6 +2,10 @@ name: "Upload GitHub Pages artifact"
 description: "A composite action that prepares your static assets to be deployed to GitHub Pages"
 author: "GitHub"
 inputs:
+  name:
+    description: 'Artifact name'
+    required: false
+    default: 'github-pages'
   path:
     description: "Path of the directory containing the static assets."
     required: true
@@ -10,6 +14,10 @@ inputs:
     description: "Duration after which artifact will expire in days."
     required: false
     default: "1"
+outputs:
+  artifact_id:
+    description: "The ID of the artifact that was uploaded."
+    value: ${{ steps.upload-artifact.outputs.artifact-id }}
 runs:
   using: composite
   steps:
@@ -17,10 +25,7 @@ runs:
       shell: sh
       if: runner.os == 'Linux'
       run: |
-        for f in $(chmod -c -R +r . | awk '{print substr($3, 2, length($3)-2)}')
-        do
-          echo "::warning::Added read permission to $f"
-        done
+        echo ::group::Archive artifact
         tar \
           --dereference --hard-dereference \
           --directory "$INPUT_PATH" \
@@ -28,6 +33,7 @@ runs:
           --exclude=.git \
           --exclude=.github \
           .
+        echo ::endgroup::
       env:
         INPUT_PATH: ${{ inputs.path }}
 
@@ -36,10 +42,7 @@ runs:
       shell: sh
       if: runner.os == 'macOS'
       run: |
-        for f in $(chmod -v -R +r .)
-        do
-          echo "::warning::Added read permission to $f"
-        done
+        echo ::group::Archive artifact
         gtar \
           --dereference --hard-dereference \
           --directory "$INPUT_PATH" \
@@ -47,6 +50,7 @@ runs:
           --exclude=.git \
           --exclude=.github \
           .
+        echo ::endgroup::
       env:
         INPUT_PATH: ${{ inputs.path }}
 
@@ -55,6 +59,7 @@ runs:
       shell: bash
       if: runner.os == 'Windows'
       run: |
+        echo ::group::Archive artifact
         tar \
           --dereference --hard-dereference \
           --directory "$INPUT_PATH" \
@@ -63,12 +68,15 @@ runs:
           --exclude=.github \
           --force-local \
           "."
+        echo ::endgroup::
       env:
         INPUT_PATH: ${{ inputs.path }}
 
     - name: Upload artifact
-      uses: actions/upload-artifact@main
+      id: upload-artifact
+      uses: actions/upload-artifact@v4
       with:
-        name: github-pages
+        name: ${{ inputs.name }}
         path: ${{ runner.temp }}/artifact.tar
         retention-days: ${{ inputs.retention-days }}
+        if-no-files-found: error