Skip to content

Drop support for the [embed:link:<content_id>] syntax#466

Draft
ChrisBAshton wants to merge 2 commits intomainfrom
remove-unused-embed_link-syntax
Draft

Drop support for the [embed:link:<content_id>] syntax#466
ChrisBAshton wants to merge 2 commits intomainfrom
remove-unused-embed_link-syntax

Conversation

@ChrisBAshton
Copy link
Copy Markdown
Contributor

This was added in 2016 but doesn't appear to ever have been used.

Recent analysis in Whitehall shows zero usage in the wild. A re-run of the analysis also shows zero matched documents in Whitehall, through running:

rake 'reporting:matching_docs[embed:link]'

(as per https://docs.publishing.service.gov.uk/manual/find-usage-of-govspeak-in-content.html)

Given the feature was allegedly brought into govspeak to retain feature parity with Whitehall (according to the changelog entry for v4.0.0), the absence of the syntax from any Whitehall content should give us reasonable confidence that the feature is not in use anywhere.

Therefore we are removing this feature as it is unnecessary.


This repo is owned by the publishing platform team. Please let us know in #govuk-publishing-platform when you raise any PRs.

This was [added in 2016](https://github.com/alphagov/govspeak/pull/83C)
but doesn't appear to ever have been used.

[Recent analysis in Whitehall](https://docs.google.com/spreadsheets/d/1ps58qqD0zgbWR-H0K6jmWJM-KhYBl6JApi5ZawOxmeU/edit?pli=1&gid=0#gid=0)
shows zero usage in the wild. A re-run of the analysis also shows
zero matched documents in Whitehall, through running:

```
rake 'reporting:matching_docs[embed:link]'
```
(as per https://docs.publishing.service.gov.uk/manual/find-usage-of-govspeak-in-content.html)

Given the feature was allegedly brought into govspeak to retain
feature parity with Whitehall (according to the changelog entry
for v4.0.0), the absence of the syntax from any Whitehall content
should give us reasonable confidence that the feature is not in
use anywhere.

Therefore we are removing this feature as it is unnecessary.
@ChrisBAshton ChrisBAshton force-pushed the remove-unused-embed_link-syntax branch 3 times, most recently from 401a7d4 to 7550cc8 Compare January 27, 2026 14:54
Technically a breaking change, but given the due diligence applied
in the previous commit, this shouldn't break things for anybody.
It seems overkill to go for a major version increase as a result.

So, minor bump here (a patch, conversely, feels too small).
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.

1 participant