Split mkdocs build and deploy into separate jobs

Created on 29 March 2025, 8 days ago

Problem/Motivation

The results of mkdoc build cannot be seen without merging into the default branch. It would be nice to be able to preview changes.

Steps to reproduce

  • Create an issue fork repository.
  • Make changes to documentation in the /docs directory.
  • Push your changes to your forked repository.
  • The mkdocs job will not run and you cannot see your changes.

Proposed resolution

Separate the mkdocs build and the GitLab pages deploy into two jobs so the build results can be seen in the artifact browser.

Ideally, the changes would be deployed using GitLab Pages to a separate URL that doesn't overwrite the deployment from the default branch, but I don't know if this is possible.

Remaining tasks

  • Separate the current job into a build job and a deploy job.

User interface changes

The pipelines in GitLab will change slightly.

πŸ“Œ Task
Status

Active

Version

1.0

Component

Other

Created by

πŸ‡ΊπŸ‡ΈUnited States alexdmccabe Orlando, FL, US / Seminole lands

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @alexdmccabe
  • πŸ‡ΊπŸ‡ΈUnited States alexdmccabe Orlando, FL, US / Seminole lands
  • Pipeline finished with Failed
    8 days ago
    #460325
  • Merge request !6Issue #3516150: Split up jobs β†’ (Merged) created by Unnamed author
  • Pipeline finished with Failed
    8 days ago
    #460326
  • Pipeline finished with Failed
    8 days ago
    #460329
  • Pipeline finished with Failed
    8 days ago
    #460330
  • Pipeline finished with Success
    8 days ago
    Total: 84s
    #460335
  • Pipeline finished with Success
    8 days ago
    Total: 82s
    #460340
  • Pipeline finished with Canceled
    8 days ago
    Total: 200s
    #460342
  • Pipeline finished with Canceled
    8 days ago
    Total: 79s
    #460345
  • Pipeline finished with Success
    8 days ago
    Total: 110s
    #460346
  • Pipeline finished with Success
    8 days ago
    Total: 81s
    #460354
  • Pipeline finished with Success
    8 days ago
    Total: 85s
    #460357
  • Pipeline finished with Success
    8 days ago
    #460358
  • πŸ‡ΊπŸ‡ΈUnited States alexdmccabe Orlando, FL, US / Seminole lands
  • Pipeline finished with Success
    7 days ago
    Total: 198s
    #460831
  • πŸ‡ΊπŸ‡ΈUnited States jdleonard Austin, TX, USA

    @alexdmccabe there's now a merge conflict that I think you'll be able to resolve more efficiently than I.

    Ideally, the changes would be deployed using GitLab Pages to a separate URL that doesn't overwrite the deployment from the default branch, but I don't know if this is possible.

    I think we saw this work recently here πŸ“Œ Set up MkDocs for docs.memberplatform.org Active , no?

  • Pipeline finished with Success
    5 days ago
    #461938
  • πŸ‡ΊπŸ‡ΈUnited States alexdmccabe Orlando, FL, US / Seminole lands

    Conflict fixed. Ready for re-review.

  • Pipeline finished with Success
    5 days ago
    Total: 81s
    #462054
  • πŸ‡ΊπŸ‡ΈUnited States jdleonard Austin, TX, USA

    Very nifty, thanks!

    I tried to find a way to get the preview URL bubbled up somewhere more discoverable than the job logs, but failed :(

  • πŸ‡ΊπŸ‡ΈUnited States jdleonard Austin, TX, USA
  • πŸ‡ΊπŸ‡ΈUnited States alexdmccabe Orlando, FL, US / Seminole lands

    I might have figured that out with the environment key in the GitLab CI/CD YAML.

    I'll open a follow-up issue.

Production build 0.71.5 2024