How to write custom action to publish pages?

[budarin]

Select Topic Area

Question

Body

I've created the action but it does not work

name: Publish Pages

on:
    workflow_run:
        workflows: ['Build the project', 'Playwright Tests']
        types: [completed]
        branches: [master]

permissions:
    pages: write
    id-token: write

jobs:
    publish:
        runs-on: ubuntu-latest
        if: ${{ github.event.workflow_run.conclusion == 'success' }}
        timeout-minutes: 5

        environment:
            name: github-pages
            url: ${{ steps.deployment.outputs.page_url }}

        steps:
            - name: Git Checkout
              uses: actions/checkout@v3

            - name: Setup Node
              id: setup_node_step
              uses: actions/setup-node@v3
              with:
                  node-version: '20'

            - name: build
              run: yarn build

            - name: Upload Pages Artifact
              uses: actions/upload-artifact@v2
              with:
                  name: github-pages
                  path: docs/ # Измените на директорию, где находятся собранные файлы

            - name: Deploy Pages
              id: deployment
              uses: actions/deploy-pages@v2

Build command creates docs folder
Default publish page action successfully publishes the pages but mine - not

Error:

the error message by link in error

{
    "$id": "1",
    "innerException": null,
    "message": "The user 'System:PublicAccess;aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa' is not authorized to access this resource.",
    "typeName": "Microsoft.TeamFoundation.Framework.Server.UnauthorizedRequestException, Microsoft.TeamFoundation.Framework.Server",
    "typeKey": "UnauthorizedRequestException",
    "errorCode": 0,
    "eventId": 3000
}

[airtower-luna]

Can you look at the content of the artifact? I'm surprised the workflow didn't fail in the checkout step already, because the permissions don't include read access to repository contents. 🤔

[airtower-luna]

Try to add an actions/configure-pages step to the job. The documentation doesn't explicitly say it's required, but all the starter workflows use it. 🤔

[budarin]

workflow

[airtower-luna]

Two more thoughts:

• Did you actually enable Pages deployment from a custom workflow in the repository settings? actions/configure-pages docs mention that can't be done automatically unless you provide a PAT.
• Just a guess: Maybe the workflow trigger (workflow_run instead of push) makes a difference somewhere non-obvious? Just a guess though.

[budarin]

The 2nd point is not really understood

[airtower-luna]

That config looks correct to me.

I mean that all the examples of pages deployments I've seen so far used a push event to trigger. A workflow_run event has different properties. I'm simply wondering if that makes a difference, somewhere where it's not obvious but breaks the deployment. It's just a guess, but one that's relatively easy to test. 😅

[ChristopherHX]

I usually use actions/upload-pages-artifact@v1 to create the pages artifact, but you have been using the plain actions/upload-artifact action.

Your error message implies that GitHub Pages does not accept the format of your artifact, so this can still work by creating a valid artifact with actions/upload-pages-artifact@v1.

name: Publish Pages

on:
    workflow_run:
        workflows: ['Build the project', 'Playwright Tests']
        types: [completed]
        branches: [master]
   # push: # My workflow uses the push event, no idea if this works with workflow_run

permissions:
    contents: read
    pages: write
    id-token: write

concurrency: # Cancel parallel deployments before starting a new one
  group: "pages"
  cancel-in-progress: true

jobs:
    publish:
        runs-on: ubuntu-latest
        timeout-minutes: 5 # This is enough time?
        environment:
            name: github-pages
            url: ${{ steps.deployment.outputs.page_url }}

        steps:
            - name: Git Checkout
              uses: actions/checkout@v3

            - name: Setup Node
              id: setup_node_step
              uses: actions/setup-node@v3
              with:
                  node-version: '20'

            - name: Enable Cache
              id: cache_step
              uses: actions/cache@v3
              with:
                  key: ${{ hashFiles('yarn.lock') }}
                  path: node_modules

            - if: ${{ steps.cache_step.outputs.cache-hit != 'true' }}
              run: yarn install --frozen-lockfile

            - name: build
              run: yarn build

            - name: Setup Pages
              uses: actions/configure-pages@v3

            - name: Upload Pages Artifact
              uses: actions/upload-pages-artifact@v1 # This action is the prefered way to create a GitHub Pages artifact not upload-artifact
              with:
                  path: docs # Измените на директорию, где находятся собранные файлы

            - name: Deploy Pages
              id: deployment
              uses: actions/deploy-pages@v2

Disclaimer: I have not tested the provided example, the following is my working workflow https://github.com/ChristopherHX/runner.server/blob/main/.github/workflows/deploy-pages.yml

[airtower-luna]

Oh yes, I missed that! 😅

[budarin]

Thanks, this works!

but why actions/upload-artifact@v2 does not work?

[ChristopherHX]

why actions/upload-artifact@v2 does not work?

Because you didn't upload a tar.gz of your webpage, the upload-pages-artifact action takes care of that and calls upload-artifact with a tar.gz created from your input folder.

Artifact validation

While using this action is optional, we highly recommend it since it takes care of producing (mostly) valid artifacts.

A Pages artifact must:

• Be called github-pages
• Be a single [gzip archive][gzip] containing a single [tar file][tar]

The [tar file][tar] must:

• be under 10GB in size
• not contain any symbolic or hard links

https://github.com/actions/upload-pages-artifact#artifact-validation

I cannot answer "Why they have such a strict validation?"

[budarin]

I would download it, but I don't know how - there are no examples for action, it is not described for beginners what and how to do

[github-actions[bot]]

🕒 Discussion Activity Reminder 🕒

This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions:

1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as out of date at the bottom of the page.

2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own.

3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution.

Note: This dormant notification will only apply to Discussions with the Question label. To learn more, see our recent announcement.

Thank you for helping bring this Discussion to a resolution! 💬