actions / actions/deploy-pages

Allow deploy by artifact_id

Open
#338 2 comments 9 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
953
Forks
143
Avg merge
35m
Merged PRs (30d)
1

Description

Sometimes my workflow failed and I need to rerun it. I have both upload-pages-artifact and deploy-pages in the same job, and during the 2nd run deploy-pages will fail with:

Run actions/deploy-pages@v4
  with:
    token: ***
    timeout: 600000
    error_count: 10
    reporting_interval: 5000
    artifact_name: github-pages
    preview: false
  env:
    GITHUB_PAGES: true
Fetching artifact metadata for "github-pages" in this workflow run
Found 2 artifact(s)
Error: Fetching artifact metadata failed. Is githubstatus.com reporting issues with API requests, Pages, or Actions? Please re-run the deployment at a later time.
Error: Error: Multiple artifacts named "github-pages" were unexpectedly found for this workflow run. Artifact count is 2.
    at getArtifactMetadata (/home/runner/work/_actions/actions/deploy-pages/v4/src/internal/api-client.js:89:1)
    at processTicksAndRejections (node:internal/process/task_queues:95:5)
    at Deployment.create (/home/runner/work/_actions/actions/deploy-pages/v4/src/internal/deployment.js:66:1)
    at main (/home/runner/work/_actions/actions/deploy-pages/v4/src/index.js:30:1)
Error: Error: Multiple artifacts named "github-pages" were unexpectedly found for this workflow run. Artifact count is 2.

upload-pages-artifact already outputs artifact_id which should be unique between runs, and #251 seems already have the plumbing laid out. If we can pass this artifact_id to deploy-pages there will be no ambiguity for which artifact we want to upload.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the artifact lookup in src/internal/api-client.js and the deployment flow in src/internal/deployment.js and src/internal/index.js, then compare the related plumbing from issue #251. Done means deploy-pages can receive the upload-pages-artifact artifact_id and select the intended artifact when multiple artifacts share a name.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, javascript
Domain
devops
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.