Create workflow to auto-add SEO descriptions #23952
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This workflow automatically adds SEO descriptions to modified markdown files in the 'docs/en/' directory when a pull request is merged. It checks for existing descriptions, generates new ones using OpenAI, and commits the updates in a new branch.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a GitHub Actions workflow that automatically generates and adds SEO descriptions to documentation files when pull requests are merged. The workflow uses OpenAI's API to create concise meta descriptions for improved search engine visibility.
Key changes:
- Creates an automated workflow triggered on PR merges to specific branches
- Implements Python script for SEO description generation using OpenAI API
- Establishes branch creation and pull request automation for SEO updates
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Contributor
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 4 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Moved the SEO description generation logic from an inline script in the GitHub Actions workflow to a dedicated Python script at .github/scripts/add_seo_descriptions.py. Updated the workflow to call this script directly, improving maintainability and readability.
Enhanced the detection and updating of SEO description blocks in add_seo_descriptions.py. The script now checks for the presence and non-emptiness of the Description field, and updates or inserts the SEO block as needed, handling invalid JSON gracefully.
Co-authored-by: Copilot <[email protected]>
maliming
approved these changes
Oct 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This workflow automatically adds SEO descriptions to modified markdown files in the 'docs/en/' directory when a pull request is merged. It checks for existing descriptions, generates new ones using OpenAI, and commits the updates in a new branch.