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.

Issue fork member-3516150

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

alexdmccabe created an issue. See original summary.

alexdmccabe’s picture

alexdmccabe
he/him
Primary language English
Location Orlando, FL, US / Seminole lands
commented
Assigned: Unassigned » alexdmccabe

alexdmccabe opened merge request !6

alexdmccabe’s picture

alexdmccabe
he/him
Primary language English
Location Orlando, FL, US / Seminole lands
commented
Status: Active » Needs review
jdleonard’s picture

jdleonard
he/him
Primary language English
Location Austin, Texas
commented
Status: Needs review » Needs work

@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, no?

alexdmccabe’s picture

alexdmccabe
he/him
Primary language English
Location Orlando, FL, US / Seminole lands
commented
Status: Needs work » Needs review

Conflict fixed. Ready for re-review.

I think we saw this work recently here, no?

It's fancier now. Looking at the artifacts didn't quite work correctly. Example:

http://member-3516150-6209f7.pages.drupalcode.org/preview-6

jdleonard’s picture

jdleonard
he/him
Primary language English
Location Austin, Texas
commented
Status: Needs review » Fixed

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 :(

jdleonard’s picture

jdleonard
he/him
Primary language English
Location Austin, Texas
commented
Assigned: alexdmccabe » Unassigned
alexdmccabe’s picture

alexdmccabe
he/him
Primary language English
Location Orlando, FL, US / Seminole lands
commented

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

I'll open a follow-up issue.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.