Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 6, 2025

Overview

The documentation deployment workflow was failing because peaceiris/actions-gh-pages was pinned to a commit SHA (4b09552702d0b65573696410d4707c765da2630b) with a missing lib/index.js file.

Details

  • Updated peaceiris/actions-gh-pages from broken commit SHA to stable v4 tag in both deploy steps (GH Pages and Tutorial branch)
  • Added # zizmor: ignore[unpinned-uses] inline comments to suppress zizmor linter warnings for the unpinned action references
Original prompt

This section details on the original issue you should resolve

<issue_title>GitHub Actions workflow failing: peaceiris/actions-gh-pages action file not found</issue_title>
<issue_description>## Description

The documentation deployment workflow is failing during the "Publish Documentation" job with the following error:

##[error]File not found: '/home/runner/work/_actions/peaceiris/actions-gh-pages/4b09552702d0b65573696410d4707c765da2630b/lib/index.js'

Error Details

Root Cause

The workflow is using a commit SHA (4b09552702d0b65573696410d4707c765da2630b) to pin the peaceiris/actions-gh-pages action. This specific commit appears to have an issue where the required lib/index.js file is missing or inaccessible.

Impact

  • Documentation cannot be published to GitHub Pages
  • Tutorial content cannot be deployed to the tutorial branch
  • Affects all pushes to the main branch

Affected Lines

The issue occurs in two places in .github/workflows/doc.yml:

  • Line 134: Deploy to GH Pages step
  • Line 151: Deploy to Tutorial branch step

Proposed Solution

Update the peaceiris/actions-gh-pages action to use a stable version tag instead of a commit SHA. For example:

- uses: peaceiris/actions-gh-pages@v4

Or use the latest stable version:

- uses: peaceiris/[email protected]

Additional Notes

There's also a version inconsistency in the workflow:

  • The build-doc job uses actions/checkout@v5, actions/upload-artifact@v4
  • The deploy job uses actions/checkout@v5, actions/download-artifact@v5

The download-artifact version (v5) doesn't match the upload-artifact version (v4), which might cause compatibility issues.

Environment

  • Runner: Ubuntu 24.04.3 LTS
  • Runner Image: ubuntu-24.04 (Version: 20251126.144.1)
  • Git Version: 2.52.0</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI changed the title [WIP] Fix GitHub Actions workflow failing on documentation deployment Fix peaceiris/actions-gh-pages action file not found error Dec 6, 2025
Copilot AI requested a review from tkoyama010 December 6, 2025 09:20
Copy link
Member

@tkoyama010 tkoyama010 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot try to ignore zizmor in lines you updated.

Copy link
Contributor Author

Copilot AI commented Dec 6, 2025

@copilot try to ignore zizmor in lines you updated.

Added # zizmor: ignore[unpinned-uses] inline comments to both peaceiris/actions-gh-pages usages in commit 3cd8e96.

@tkoyama010
Copy link
Member

pre-commit.ci autofix

@tkoyama010 tkoyama010 marked this pull request as ready for review December 6, 2025 09:27
Copilot AI review requested due to automatic review settings December 6, 2025 09:27
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fixes a critical deployment failure by updating the peaceiris/actions-gh-pages action reference from a broken commit SHA to the stable v4 version tag.

  • Updated action reference to v4 tag to resolve missing lib/index.js error
  • Added zizmor linter suppression comments to document the intentional use of unpinned action references

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 6, 2025

@tkoyama010 tkoyama010 merged commit 1653559 into main Dec 6, 2025
13 checks passed
@tkoyama010 tkoyama010 deleted the copilot/fix-gh-actions-workflow branch December 6, 2025 11:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

GitHub Actions workflow failing: peaceiris/actions-gh-pages action file not found

2 participants