Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Major update to github pages publisher v4.0.0 #6333

Open
4 tasks
richgreen-moj opened this issue Feb 26, 2024 · 3 comments
Open
4 tasks

Major update to github pages publisher v4.0.0 #6333

richgreen-moj opened this issue Feb 26, 2024 · 3 comments
Labels
Low Priority On hold - but would be good to do

Comments

@richgreen-moj
Copy link
Contributor

richgreen-moj commented Feb 26, 2024

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

  • Any breaking changes been reviewed to assess any remediation required
  • Remediation completed and version updated
  • Testing completed successfully
  • Another team member has reviewed
@richgreen-moj richgreen-moj added needs refining Low Priority On hold - but would be good to do labels Feb 26, 2024
Copy link
Contributor

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

@github-actions github-actions bot added the Stale label May 30, 2024
@dms1981
Copy link
Contributor

dms1981 commented Aug 1, 2024

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

@github-actions github-actions bot removed the Stale label Aug 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Low Priority On hold - but would be good to do
Projects
Status: To Do
Development

No branches or pull requests

3 participants