Skip to content

Export inclusive language csv contents#21987

Merged
mhkuu merged 7 commits intotrunkfrom
export-inclusive-language-csv
Jan 31, 2025
Merged

Export inclusive language csv contents#21987
mhkuu merged 7 commits intotrunkfrom
export-inclusive-language-csv

Conversation

@rohans456
Copy link
Copy Markdown
Contributor

@rohans456 rohans456 commented Jan 22, 2025

Context

  • GitHub action to generate the CSV file contents.

Summary

This action would allow the creation of the CSV file contents with the inclusive language configuration. This action can be triggered from the GitHub interface.

This PR can be summarized in the following changelog entry:

  • Introduces a GitHub action to generate CSV file contents with the inclusive language configuration. The action can be triggered directly from the GitHub interface.
  • [yoastseo] Adds a yarn command to extract the inclusive language configuration.

Relevant technical choices:

  • YML, JavaScript

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  1. Go to the "Actions" tab
  2. Select "Generate CSV" from the Workflow list
  3. Click on "Run workflow"
  4. Refresh the page and click on the run build
  5. Click on "run-commands" and wait for the process to complete
  6. The contents of the CSV file will be generated and displayed in the log.
  7. Copy and save the contents to a blank file and save in the csv format to see the actual content.

You can run a demo by visiting the workflow on this forked repository: https://github.com/rohans456/wordpress-seo/actions/workflows/generate_csv.yml

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.

QA can test this PR by following these steps:

  • No QA needed, this is just an action.

Impact check

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

  • None.

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/lingo-other-tasks/issues/497

@rohans456 rohans456 requested a review from mhkuu January 22, 2025 13:27
@coveralls
Copy link
Copy Markdown

coveralls commented Jan 22, 2025

Pull Request Test Coverage Report for Build 6c5aea2133812591d80bcd8d489f6fa1954bb68e

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 49 unchanged lines in 10 files lost coverage.
  • Overall coverage increased (+0.07%) to 54.666%

Files with Coverage Reduction New Missed Lines %
packages/js/src/integrations-page/simple-integration.js 1 84.62%
packages/components/src/image-select/ImageSelect.js 2 85.0%
packages/js/src/initializers/settings-store.js 2 0.0%
packages/social-metadata-previews/src/editor/SocialPreviewEditor.js 3 0.0%
packages/js/src/components/social/SocialForm.js 4 0.0%
packages/js/src/components/social/TwitterWrapper.js 6 0.0%
packages/js/src/integrations-page/recommended-integrations.js 6 0.0%
packages/social-metadata-forms/src/SocialMetadataPreviewForm.js 6 0.0%
packages/js/src/components/social/FacebookWrapper.js 9 0.0%
packages/js/src/integrations-page/helper.js 10 21.74%
Totals Coverage Status
Change from base Build df0bc85d18ba1d1ee47d9e86c715107e398c9892: 0.07%
Covered Lines: 30137
Relevant Lines: 55523

💛 - Coveralls

Copy link
Copy Markdown
Contributor

@mhkuu mhkuu left a comment

Choose a reason for hiding this comment

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

Nice work, let's improve a little bit more by limiting the output further and adhering to the coding standards! 👍 Please also read https://yoast.atlassian.net/wiki/spaces/LIN/pages/2464317534/Development+DoD to further improve the pull request (e.g. add a label, add a changelog, etc.).

Comment thread packages/yoastseo/package.json Outdated
@rohans456 rohans456 added the changelog: enhancement Needs to be included in the 'Enhancements' category in the changelog label Jan 28, 2025
@rohans456 rohans456 requested a review from mhkuu January 30, 2025 16:10
@mhkuu mhkuu added changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog and removed changelog: enhancement Needs to be included in the 'Enhancements' category in the changelog labels Jan 31, 2025
Copy link
Copy Markdown
Contributor

@mhkuu mhkuu left a comment

Choose a reason for hiding this comment

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

Nice work! 🎉

@mhkuu mhkuu added this to the 24.5 milestone Jan 31, 2025
@mhkuu
Copy link
Copy Markdown
Contributor

mhkuu commented Jan 31, 2025

ACC: works as supposed! 🎉

@mhkuu mhkuu merged commit c975fa0 into trunk Jan 31, 2025
@mhkuu mhkuu deleted the export-inclusive-language-csv branch January 31, 2025 14:10
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