ministryofjustice / modernisation-platform

A place for the core work of the Modernisation Platform • This repository is defined and managed in Terraform
https://user-guide.modernisation-platform.service.justice.gov.uk
MIT License
683 stars 291 forks source link

Major update to github pages publisher v4.0.0 #6333

Open richgreen-moj opened 7 months ago

richgreen-moj commented 7 months ago

User Story

As a MP engineer I want to update the tech docs github page publisher to the latest version So that the platforms dependencies are kept up to date

Value / Purpose

The tech docs github page publisher has had a major upgrade (v4.0.0). We need to review the breaking changes and update to the latest version.

For more information see this Slack post

We make use of this in the publish-gh-pages repo

Useful Contacts

No response

Additional Information

In the Slack post David Read mentions that we shouldn't be using the crown logo in our docs - we should keep an eye on whether the issue he raised with CDDO has been addressed before implementing the ticket.

Proposal / Unknowns

Definition of Done

ASTRobinson commented 7 months ago

https://insidegovuk.blog.gov.uk/2024/02/19/updating-gov-uks-crown/?mc_cid=a695e35983&mc_eid=2f7192c536

github-actions[bot] commented 4 months ago

This issue is stale because it has been open 90 days with no activity.

dms1981 commented 2 months ago

From what I've seen this should be fairly simple. Bump the version and then swap this:

      - name: Compile Markdown to HTML and create artifact
        run: |
          /scripts/deploy.sh

For this:

      - name: Compile Markdown to HTML and create artifact
        run: |
          /usr/local/bin/package

But it's probably worth us looking at how AP publish their docs as a comparator. For example, pulling the lychee job into our process for building the docs