Skip to content

docs-build.yml writes PR number metadata but no deploy workflow consumes it #5650

@Devansh-567

Description

@Devansh-567

In .github/workflows/docs-build.yml, the "Write PR number metadata" step saves the PR number to _meta/pr_number.txt inside the doxygen-html artifact. The comment in the workflow says: "Write the PR number into the artifact so the deploy workflow can read it back."

However, I don't see a corresponding deploy workflow that consumes this artifact and posts a preview link or deploys to GitHub Pages. Was this intentional - i.e. is a docs-deploy.yml workflow planned? If so, I'd like to implement it.

My proposed approach:

  • New workflow docs-deploy.yml triggered by workflow_run on docs-build
  • Downloads the artifact, reads the PR number from _meta/pr_number.txt
  • Posts a comment on the PR with a link to the uploaded artifact or a Pages preview

Happy to discuss the approach before writing code.

Metadata

Metadata

Assignees

No one assigned

    Labels

    infrastructureTopics related to code style and build and test infrastructure.

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions