v5.0.0

⚠️ Breaking Changes

As documented in the release notes of tech-docs-gem v4.0.0:

• BREAKING: drop support for end-of-life Ruby versions 2.7 and 3.0. The minimum Ruby version is now 3.1.
• BREAKING: drop support for IE8
• BREAKING: Upgrade to govuk-frontend v5.7.1 and introduce new Javascript entry point

The additional file source/javascripts/govuk_frontend.js is now required, you can find a copy here.

Most up-to-date documentation on breaking changes can be found in the CHANGELOG.md

What's Changed

• 🚑 Remove Lychee by @jacobwoffenden in #122
• Add a GitHub releaser step to the "Release" CICD pipeline by @jasonBirchall in #123
• 🚀 Update govuk_tech_docs to 4.1.0 by @jacobwoffenden in #161
• Bump actions/dependency-review-action from 4.1.3 to 4.3.5 by @dependabot in #160
• Bump docker/login-action from 3.0.0 to 3.3.0 by @dependabot in #144
• Bump docker/build-push-action from 5.1.0 to 6.9.0 by @dependabot in #157
• 🆙 Update softprops/actions-gh-release to v2.0.8 by @connormaglynn in #162
• ♻️ Refactor repository by @jacobwoffenden in #163

Full Changelog: v4.0.0...v5.0.0

v4.0.0

What's Changed

• ♻️ Refactor and Upgrade by @jacobwoffenden in #120

New Contributors

• @jacobwoffenden made their first contribution in #120

Full Changelog: v3.0.2...v4.0.0

v3.0.2

What's Changed

• feat: 🎸 allow check_interal_hash to be overridden by @jaskaransarkaria in #119

New Contributors

• @jaskaransarkaria made their first contribution in #119

Full Changelog: v3.0.1...v3.0.2

v3.0.1

What's Changed

• Bump govuk_tech_docs from 3.2.1 to 3.4.0 to mitigate CVE-2024-22048

New Contributors

• @jasonBirchall made their first contribution in #97
• @connormaglynn made their first contribution in #115

Full Changelog: v3...v3.0.1

v3

Breaking Change

The scripts in the Docker container have changed.

scripts/deploy.sh is now used to check internal links only during the deploy stage. See .github/workflows/publish-gh-pages.yml below.

[Optional]: Use the scripts/check-url-links.sh to test internal and external URLs, it may produce false errors for valid working URLs. Add the .github/workflows/check-links.yml below to run the check when the PR is created. The false errors can be ignored.

What's Changed

• Bump html-proofer to 4.4.3 by @dependabot in #63
• Check urls, update readme for v3 release and code format files by @NickWalt01 in #64

Full Changelog: v2...v3

v2

Breaking Change

• If you have a branch called gh-pages already rename it to gh-pages-old. In repository settings, go to Pages, copy the 'Custom domain' value, for 'Build and deployment' 'Source' change to the option 'GitHubs Actions'. Then apply the new yml code in the README.md in your CI Action that published gh-pages. If all is working can remove the gh-pages-old branch.

What's Changed

• Dependabot dependency updates
• Bump Code-Formatter v7
• Add the dependency-review.yml GH Action
• Bump html-proofer
• Use GH gh-pages action v1 to upload documentation site to GH pages
• Use html-proofer vebrose option

Full Changelog: 1.5...v2

1.5

What's Changed

• manually run CI script by @NickWalt01 in #26
• Bump govuk_tech_docs from 3.2.0 to 3.2.1 by @dependabot in #27
• Bump docker/login-action from 1 to 2 by @dependabot in #30
• Bump docker/build-push-action from 2 to 3 by @dependabot in #29
• Bump docker/setup-buildx-action from 1 to 2 by @dependabot in #28
• Bump nokogiri from 1.13.4 to 1.13.6 by @dependabot in #31
• Bump html-proofer from 3.19.3 to 3.19.4 by @dependabot in #32
• For v1.5 revert Ruby to v2.7.6 for compatibility reasons by @NickWalt01 in #33

Full Changelog: v1.5...1.5