Repository navigation
Fix documentation issue template link to use documentation.yml (#3149) #3200
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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 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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| import re | ||
| from pathlib import Path | ||
|
|
||
| import yaml | ||
| from django.conf import settings | ||
| from django.test import SimpleTestCase | ||
|
|
||
|
|
||
| class IssueTemplateTestCase(SimpleTestCase): | ||
| """Tests to validate GitHub issue templates.""" | ||
|
|
||
| def setUp(self): | ||
| self.issue_template_dir = Path(settings.BASE) / ".github" / "ISSUE_TEMPLATE" | ||
|
|
||
| def test_issue_templates_exist_and_are_valid_yaml(self): | ||
| """Ensure issue template YAML files exist and are syntactically valid.""" | ||
| yml_files = list(self.issue_template_dir.glob("*.yml")) | ||
| self.assertGreater(len(yml_files), 0, "No issue template YAML files found") | ||
|
|
||
| for file_path in yml_files: | ||
| content = file_path.read_text(encoding="utf-8") | ||
| parsed = yaml.safe_load(content) | ||
| self.assertIsInstance(parsed, dict, f"{file_path.name} did not parse into a valid YAML mapping") | ||
|
|
||
| def test_cpython_documentation_template_links_use_yml(self): | ||
| """Regression test for #3149: verify documentation issue links use .yml not .md.""" | ||
| template_files = ["BUG.yml", "DOCS.yml", "REQUEST.yml"] | ||
| docs_url_pattern = re.compile(r"https://github\.com/python/cpython/issues/new\?[^)\s]+") | ||
|
|
||
| for filename in template_files: | ||
| file_path = self.issue_template_dir / filename | ||
| self.assertTrue(file_path.exists(), f"{filename} does not exist") | ||
| content = file_path.read_text(encoding="utf-8") | ||
|
|
||
| # Must not contain the broken .md link | ||
| self.assertNotIn( | ||
| "template=documentation.md", | ||
| content, | ||
| f"{filename} contains invalid template=documentation.md link (should be .yml)", | ||
| ) | ||
|
|
||
| # Must contain the valid .yml link | ||
| self.assertIn( | ||
| "template=documentation.yml", | ||
| content, | ||
| f"{filename} is missing expected template=documentation.yml link", | ||
| ) | ||
|
|
||
| # Ensure every cpython documentation link found uses .yml | ||
| for match in docs_url_pattern.findall(content): | ||
| if "labels=docs" in match: | ||
| self.assertIn( | ||
| "template=documentation.yml", | ||
| match, | ||
| f"Found broken link in {filename}: {match}", | ||
| ) |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the link fixes.
I don't think we need this validation, please remove it.