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.

Sign up for GitHub

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

Jump to bottom

Update how Design System and Frontend Docs consume GOV.UK Frontend #4018

Closed
8 tasks done
stevenjmesser opened this issue Jul 28, 2023 · 1 comment · Fixed by alphagov/govuk-design-system#2977 or alphagov/govuk-frontend-docs#333
Closed
8 tasks done

Update how Design System and Frontend Docs consume GOV.UK Frontend #4018

stevenjmesser opened this issue Jul 28, 2023 · 1 comment · Fixed by alphagov/govuk-design-system#2977 or alphagov/govuk-frontend-docs#333
Labels
epic Epics are used in planning project boards to group related stories interoperability tooling
Milestone
v5.0

Comments

@stevenjmesser
Copy link

stevenjmesser commented Jul 28, 2023 •
edited by romaricpascal
Loading

What

Update our own websites to match our new recommendations for loading JavaScript and use the branch deployments to test out preview/pre-releases of our changes to govuk-frontend.

Each of the repositories will have a "staging" release/5.0 branches gathering all the v5.0 updates. These branches also provide a Netlify preview for us to check our all the merged changes so far:

To test a new pre-release we will:

  • open a PR (say on a preview/5.0.0-alpha.X branch) to merge a version update of GOV.UK Frontend and do any adjustment for breaking changes, pointed at release/5.0
  • review that PR and fix any bugs noticed in the review
  • once bugs have been squashed, merge the branch into release/5.0

Why

5.0 changes our recommendations for loading GOV.UK Frontend's JavaScript. We need to update our own websites to match these new recommendations.

Our websites also allow us to try out our changes before releasing them to a wider audience, so we want to take advantage of that.

Who needs to work on this

Developers

Who needs to review this

Developers

Done when

Design System site
Preview Give feedback
  1. Preview v5: Update to use <script type="module"> govuk-design-system#2958
  2. Preview v5: Skip initialisation when GOV.UK Frontend is not supported govuk-design-system#2976
  3. Preview v5: Configure ESLint checks for ES2015 govuk-design-system#2959
  4. Preview v5: Convert all components to ES2015 classes govuk-design-system#2960
  5. Preview v5: Follow GOV.UK Frontend coding standards govuk-design-system#2961

Frontend docs
Preview Give feedback
  1. Preview v5: Update package paths for govuk-frontend@5 govuk-frontend-docs#318
    documentation
  2. Preview v5: Remove references to IE8 in code govuk-frontend-docs#334
    documentation
  3. Preview v5: GitHub Actions fixes govuk-frontend-docs#335
@stevenjmesser stevenjmesser added the awaiting triage Needs triaging by team label Jul 28, 2023
@stevenjmesser stevenjmesser added this to the v5.0 milestone Jul 28, 2023
@stevenjmesser stevenjmesser added epic Epics are used in planning project boards to group related stories and removed awaiting triage Needs triaging by team labels Jul 28, 2023
@romaricpascal romaricpascal changed the title Update the Design System and Frontend Docs sites to use GOV.‌UK Frontend v5.0 Update the Design System and Frontend Docs sites to match 5.0 guidance Jul 28, 2023
@romaricpascal romaricpascal changed the title Update the Design System and Frontend Docs sites to match 5.0 guidance Update how Design System and Frontend Docs consume GOV.UK Frontend Jul 28, 2023
@stevenjmesser stevenjmesser moved this from Backlog 🗄 to In progress 📝 in GOV.UK Design System cycle board Jul 31, 2023
This was linked to pull requests Nov 3, 2023
Updates for GOV.UK Frontend v5.0.0 alphagov/govuk-design-system#2977
Merged
Updates for GOV.UK Frontend v5.0.0 alphagov/govuk-frontend-docs#333
Merged
@colinrotherham colinrotherham removed their assignment Nov 3, 2023
@romaricpascal
Copy link
Member

Closing at it's all done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
epic Epics are used in planning project boards to group related stories interoperability tooling
Projects
None yet
Milestone
v5.0
4 participants
@romaricpascal @colinrotherham @querkmachine @stevenjmesser