Skip to content

Refactor Markdown integration#1120

Merged
lfdebrux merged 2 commits intomainfrom
ldeb-refactor-application-markdown
Apr 8, 2026
Merged

Refactor Markdown integration#1120
lfdebrux merged 2 commits intomainfrom
ldeb-refactor-application-markdown

Conversation

@lfdebrux
Copy link
Copy Markdown
Contributor

@lfdebrux lfdebrux commented Apr 1, 2026

What problem does this pull request solve?

Instead of ApplicationMarkdown inheriting from GovukMarkdown::Renderer and reimplementing the interface expected by markdown-rails (which is not the expected way of using that gem), make ApplicationMarkdown look more like the template file from markdown-rails and mixin the govuk-markdown functionality.

This makes our code much simpler, and it easier to manage updates of the markdown_rails gem.

Things to consider when reviewing

  • Does it work when run on your machine?
  • Is it clear what the code is doing?
  • Do the commit messages explain why the changes were made?
  • Are there all the unit tests needed?
  • Do the end to end tests need updating before these changes will pass?
  • Has all relevant documentation been updated?

lfdebrux added 2 commits April 1, 2026 09:31
Bumps [govuk_markdown][https://github.com/DFE-Digital/govuk-markdown] from 2.0.3 to 2.0.4.
- [Release notes](https://github.com/DFE-Digital/govuk-markdown/releases/tag/v2.0.4)
- [Commits](DFE-Digital/govuk-markdown@v2.0.3...v2.0.4)

We require 2.0.4 in the Gemfile because we want to use the mixin feature
added in this release.
Instead of ApplicationMarkdown inheriting from GovukMarkdown::Renderer
and reimplementing the interface expected by markdown-rails (which is
not the expected way of using that gem), make ApplicationMarkdown look
more like the template file from markdown-rails and mixin the
govuk-markdown functionality.

This makes our code much simpler, and it easier to manage updates of
the `markdown_rails` gem.
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 1, 2026

🎉 A review copy of this PR has been deployed! You can reach it at: https://pr-1120.www.review.forms.service.gov.uk/

It may take 5 minutes or so for the application to be fully deployed and working. If it still isn't ready
after 5 minutes, there may be something wrong with the ECS task. You will need to go to the integration AWS account
to debug, or otherwise ask an infrastructure person.

For the sign in details and more information, see the review apps wiki page.

@lfdebrux lfdebrux added this pull request to the merge queue Apr 8, 2026
Merged via the queue into main with commit 0927a3b Apr 8, 2026
8 checks passed
@lfdebrux lfdebrux deleted the ldeb-refactor-application-markdown branch April 8, 2026 09:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants