Problem/Motivation

Adding MkDocs files to a project triggers the 'pages' job which builds the documentation site. But there is very little information shown in the log on what has actually been done.

The pages job log has

Building documentation to directory: /builds/project/{project name}/public

but nothing else useful.

The pages:deploy log is not viewable.

Proposed resolution

Give some information on what has been built and where the new documentation exists, and provide a url

Issue fork gitlab_templates-3485285

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

jonathan1055 created an issue. See original summary.

jonathan1055’s picture

jonathan1055 CreditAttribution: jonathan1055 as a volunteer commented
Issue summary: View changes

Here is an example pipeline
https://git.drupalcode.org/project/scheduler/-/pipelines/328214

Is the pages:deploy job log viewable by a user with higher authority than the project maintainer?

The documentation site is https://project.pages.drupalcode.org/scheduler but this is not shown in any job log or help page. Maybe we can at minimum add this to the pages log?

fjgarlin’s picture

fjgarlin CreditAttribution: fjgarlin as a volunteer and at Drupal Association commented

The only place where we can add some useful logs is here: https://git.drupalcode.org/project/gitlab_templates/-/blob/main/includes...

pages:deploy is a GitLab specific job, so we have no control, but we can definitely add things to the pages job. There is an CI variable with the URL to the generated site, so we can echo that.

jonathan1055 opened merge request !283

jonathan1055’s picture

jonathan1055 CreditAttribution: jonathan1055 as a volunteer commented
Status: Active » Needs review

Tested here
https://git.drupalcode.org/project/scheduler/-/pipelines/330500

Is there anything else we can add?

fjgarlin’s picture

fjgarlin CreditAttribution: fjgarlin as a volunteer and at Drupal Association commented
Status: Needs review » Needs work

I suggested a small change in the MR.

lavanyatalwar’s picture

lavanyatalwar CreditAttribution: lavanyatalwar as a volunteer and at Innoraft for Drupal India Association commented

@fjgarlin,
How about adding a line of dashes as a divider?

fjgarlin’s picture

fjgarlin CreditAttribution: fjgarlin as a volunteer and at Drupal Association commented

That's almost exactly the comment that I made in the MR. DIVIDER is just a bunch of * characters.

lavanyatalwar’s picture

lavanyatalwar CreditAttribution: lavanyatalwar as a volunteer and at Innoraft for Drupal India Association commented
Assigned: Unassigned » lavanyatalwar

Working on it.

fjgarlin’s picture

fjgarlin CreditAttribution: fjgarlin as a volunteer and at Drupal Association commented

Perfect. Look at other examples of how it is used within the file for reference.

lavanyatalwar’s picture

lavanyatalwar CreditAttribution: lavanyatalwar as a volunteer and at Innoraft for Drupal India Association commented
Assigned: lavanyatalwar » Unassigned
Status: Needs work » Needs review

@fjgarlin ,
Added the divider as desired.
Kindly check and merge :)

fjgarlin’s picture

fjgarlin CreditAttribution: fjgarlin as a volunteer and at Drupal Association commented
Status: Needs review » Needs work

I gave feedback in the MR.

lavanyatalwar’s picture

lavanyatalwar CreditAttribution: lavanyatalwar as a volunteer and at Innoraft for Drupal India Association commented
Status: Needs work » Needs review

@fjgarlin, done with the changes
Please have a look.

fjgarlin’s picture

fjgarlin CreditAttribution: fjgarlin as a volunteer and at Drupal Association commented
Status: Needs review » Needs work

Feedback in the MR.

lavanyatalwar’s picture

lavanyatalwar CreditAttribution: lavanyatalwar as a volunteer and at Innoraft for Drupal India Association commented
Status: Needs work » Needs review

@fjgarlin, please check.

jonathan1055’s picture

jonathan1055 CreditAttribution: jonathan1055 as a volunteer commented
Status: Needs review » Needs work

I left a further comment in the MR

lavanyatalwar’s picture

lavanyatalwar CreditAttribution: lavanyatalwar as a volunteer and at Innoraft for Drupal India Association commented
Status: Needs work » Needs review

@fjgarlin @jonathan1055,
Removed the extra '\n' character and '\' before $CI_PAGES_URL.
Kindly review :)

jonathan1055’s picture

jonathan1055 CreditAttribution: jonathan1055 as a volunteer commented

Thanks for fixing the message. Here is the test before
https://git.drupalcode.org/project/scheduler/-/jobs/3272612

and after
https://git.drupalcode.org/project/scheduler/-/jobs/3279263

All looks good now, but I will make an adjustment for that extra $divider variable in the 'check environment' job

jonathan1055’s picture

jonathan1055 CreditAttribution: jonathan1055 as a volunteer commented

With this MR and $DIVIDER removed - 'environment check' ended green because the pipe syntax was removed and the 'exit 1' was therefore not executed
https://git.drupalcode.org/project/scheduler/-/jobs/3279475

With latest commit to this MR, 'environment check' has the correct message box and ends red as required.
https://git.drupalcode.org/project/scheduler/-/jobs/3280383

I have resolved the various MR comment threads where the code has been fixed, and also reverted the temporoary change that allowed the 'pages' job to be tested.

Unrelated pipeline fail, due to 'check versions' showing that 11.0.6 and 10.3.7 have been released. This is RTBC from me, but will let @fjgarlin do the final review.

fjgarlin’s picture

fjgarlin CreditAttribution: fjgarlin as a volunteer and at Drupal Association commented
Status: Needs review » Reviewed & tested by the community

Oh wow, I didn't catch the exit 1 being ignored, thanks for testing it!

Did a final check, agree it's good to RTBC and merge.

fjgarlin’s picture

fjgarlin CreditAttribution: fjgarlin as a volunteer and at Drupal Association commented

Downstream with keycdn running pages: https://git.drupalcode.org/issue/gitlab_templates-3485285/-/pipelines/33...

fjgarlin’s picture

fjgarlin CreditAttribution: fjgarlin as a volunteer and at Drupal Association commented
Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

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