Skip to content

Include the version of the plugin that generated the file#22274

Merged
thijsoo merged 1 commit intofeature/llms-txtfrom
613-add-the-plugin-version-in-the-txt-content
May 19, 2025
Merged

Include the version of the plugin that generated the file#22274
thijsoo merged 1 commit intofeature/llms-txtfrom
613-add-the-plugin-version-in-the-txt-content

Conversation

@leonidasmi
Copy link
Copy Markdown
Contributor

Context

Summary

This PR can be summarized in the following changelog entry:

  • Includes the version of the plugin that generated the file.

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Create the llms.txt file
  • Confirm that the intro of the file is like:
Generated by Yoast SEO v25.3, this is an llms.txt file, meant for consumption by LLMs.
  • the version should of course be the same with the plugin version you have in your setup.

Relevant test scenarios

  • Changes should be tested with the browser console open
  • Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
  • Changes should be tested on different editors (Default Block/Gutenberg/Classic/Elementor/other)
  • Changes should be tested on different browsers
  • Changes should be tested on multisite

Test instructions for QA when the code is in the RC

  • QA should use the same steps as above.

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

UI changes

  • This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

  • This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

  • I have written documentation for this change. For example, comments in the Relevant technical choices, comments in the code, documentation on Confluence / shared Google Drive / Yoast developer portal, or other.

Quality assurance

  • I have tested this code to the best of my abilities.
  • During testing, I had activated all plugins that Yoast SEO provides integrations for.
  • I have added unit tests to verify the code works as intended.
  • If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
  • I have written this PR in accordance with my team's definition of done.
  • I have checked that the base branch is correctly set.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label.
  • I have added my hours to the WBSO document.

Fixes https://github.com/Yoast/roadmap/issues/613

@leonidasmi leonidasmi added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label May 16, 2025
@leonidasmi leonidasmi added this to the feature/llms-txt milestone May 16, 2025
@coveralls
Copy link
Copy Markdown

Pull Request Test Coverage Report for Build 67dc9197923ac486befd94556b983dff6a8031f3

Details

  • 0 of 6 (0.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.004%) to 52.33%

Changes Missing Coverage Covered Lines Changed/Added Lines %
src/llms-txt/application/markdown-builders/intro-builder.php 0 6 0.0%
Totals Coverage Status
Change from base Build 04537276066d55b60b7bd227a962a4b1e6a34958: -0.004%
Covered Lines: 29150
Relevant Lines: 56853

💛 - Coveralls

Copy link
Copy Markdown
Contributor

@thijsoo thijsoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CR + ACC 👍

@thijsoo thijsoo merged commit cbf117f into feature/llms-txt May 19, 2025
27 of 28 checks passed
@thijsoo thijsoo deleted the 613-add-the-plugin-version-in-the-txt-content branch May 19, 2025 07:26
@leonidasmi leonidasmi mentioned this pull request May 21, 2025
18 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants