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

Bump govuk_tech_docs from 2.1.1 to 3.3.1 #30

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dependabot[bot]
Copy link

@dependabot dependabot bot commented on behalf of github Apr 11, 2023

Bumps govuk_tech_docs from 2.1.1 to 3.3.1.

Release notes

Sourced from govuk_tech_docs's releases.

Release v3.3.1

Fix

This change solves a potential security issue with HTML snippets. Pages indexed in search results have their entire contents indexed, including any HTML code snippets. These HTML snippets would appear in the search results unsanitised, making it possible to render arbitrary HTML or run arbitrary scripts.

You can see more detail about this issue at #323: Fix XSS vulnerability on search results page

Release v3.3.0

New features

There are some steps you should follow as the Technical Documentation Template (TDT) now uses GOV.UK Frontend 4.4.1.

  1. Update your documentation site to use the latest template version. You can follow the TDT guidance on using the latest template version.
  2. Check your documentation site displays correctly. If your site does not display correctly, you can refer to the GOV.UK Frontend release notes for more information, or contact the GOV.UK Design System team.

Fixes

Release v3.2.1

Fixes

Release v3.2.0

New features

You can now configure your Tech Docs Template (TDT) to build your documentation site to use relative links to pages and assets.

Thanks @​eddgrant for contributing this feature and the associated fixes.

This change was introduced in [pull request #291: Support sites deployed on paths other than "/" (by generating relative links)](alphagov/tech-docs-gem#291).

v3.1.0

New features

There are some steps you should follow as the Technical Documentation Template (TDT) now uses GOV.UK Frontend 4.0.0.

  1. Update your documentation site to use the latest template version. You can follow the TDT guidance on using the latest template version.
  2. Check your documentation site displays correctly. If your site does not display correctly, you can refer to the GOV.UK Frontend 4.0.0 release note for more information.

v3.0.1

Fixes

We’ve made the following fixes to the tech docs gem in [pull request #281: Don't break TOC when OpenAPI description includes headers](alphagov/tech-docs-gem#281):

  • we now render OpenAPI Markdown with the same Markdown renderer as other documents
  • table of contents (TOC) uses TechDocsHTMLRenderer to render the headings with IDs

Thanks to @​jamietanna for contributing to this issue and its solution.

... (truncated)

Changelog

Sourced from govuk_tech_docs's changelog.

3.3.1

This change solves a potential security issue with HTML snippets. Pages indexed in search results have their entire contents indexed, including any HTML code snippets. These HTML snippets would appear in the search results unsanitised, making it possible to render arbitrary HTML or run arbitrary scripts.

You can see more detail about this issue at #323: Fix XSS vulnerability on search results page

3.3.0

New features

There are some steps you should follow as the Technical Documentation Template (TDT) now uses GOV.UK Frontend 4.4.1.

  1. Update your documentation site to use the latest template version. You can follow the TDT guidance on using the latest template version.
  2. Check your documentation site displays correctly. If your site does not display correctly, you can refer to the GOV.UK Frontend release notes for more information, or contact the GOV.UK Design System team.

Fixes

3.2.1

Fixes

3.2.0

New features

You can now configure your Tech Docs Template (TDT) to build your documentation site to use relative links to pages and assets.

Thanks @​eddgrant for contributing this feature and the associated fixes.

This change was introduced in [pull request #291: Support sites deployed on paths other than "/" (by generating relative links)](alphagov/tech-docs-gem#291).

3.1.0

New features

There are some steps you should follow as the Technical Documentation Template (TDT) now uses GOV.UK Frontend 4.0.0.

  1. Update your documentation site to use the latest template version. You can follow the TDT guidance on using the latest template version.
  2. Check your documentation site displays correctly. If your site does not display correctly, you can refer to the GOV.UK Frontend 4.0.0 release note for more information.

3.0.1

Fixes

We’ve made the following fixes to the tech docs gem in [pull request #281: Don't break TOC when OpenAPI description includes headers](alphagov/tech-docs-gem#281):

... (truncated)

Commits

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
    You can disable automated security fix PRs for this repo from the Security Alerts page.

Bumps [govuk_tech_docs](https://github.com/alphagov/tech-docs-gem) from 2.1.1 to 3.3.1.
- [Release notes](https://github.com/alphagov/tech-docs-gem/releases)
- [Changelog](https://github.com/alphagov/tech-docs-gem/blob/main/CHANGELOG.md)
- [Commits](https://github.com/alphagov/tech-docs-gem/commits/v3.3.1)

---
updated-dependencies:
- dependency-name: govuk_tech_docs
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Apr 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants