Skip to content

Add markdown declaration to check your answers page, if the form has it#1945

Merged
thomasiles merged 1 commit intomainfrom
markdown-declaration
Mar 10, 2026
Merged

Add markdown declaration to check your answers page, if the form has it#1945
thomasiles merged 1 commit intomainfrom
markdown-declaration

Conversation

@thomasiles
Copy link
Contributor

Add markdown declaration to check your answers page, if the form has it

Trello card: https://trello.com/c/b8rdhhe4/2836-support-markdown-in-declaration-field

We are changing the declaration from a text field, rendered with basic formatting, to a markdown field. This matches the "what happens next" and guidance fields, which already use markdown.

The declaration is currently stored in a field in the form and form document as declaration_text. We will add a new field called declaration_markdown which will replace the text version. To support the migration between the two, the runner needs to support both.

This PR renders the declaration_markdown if it's present. If it's not, it uses declaration_text as usual.

Things to consider when reviewing

  • Ensure that you consider the wider context.
  • 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?

If declaration_markdown is present, use it over declaration_text.

This will allow us to migrate the existing markdown declarations to
markdown.
@sonarqubecloud
Copy link

sonarqubecloud bot commented Mar 4, 2026

@github-actions
Copy link
Contributor

github-actions bot commented Mar 4, 2026

🎉 A review copy of this PR has been deployed! It is made of up two components

  1. A review copy of forms-runner
  2. A production copy of forms-admin

Important

Not all of the functionality of forms-runner is present in review apps.
Functionality such as sending emails, file upload, and S3 submission types are
deliberately disabled for the sake of simplifying review apps.

You should use the full dev environment to test the functionality which is disabled here.

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.

@thomasiles thomasiles marked this pull request as ready for review March 5, 2026 09:19
@thomasiles thomasiles added this pull request to the merge queue Mar 10, 2026
Merged via the queue into main with commit 27d2721 Mar 10, 2026
7 checks passed
@thomasiles thomasiles deleted the markdown-declaration branch March 10, 2026 14:32
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