Skip to content

Enforce that changelog files are .rst #3765

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.

Sign up for GitHub

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

Merged
asottile merged 1 commit into from
Aug 2, 2018
Merged

Enforce that changelog files are .rst #3765

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,8 @@ repos:
language: python
additional_dependencies: [pygments, restructuredtext_lint]
python_version: python3.6
- id: changelogs-rst
name: changelog files must end in .rst
entry: ./scripts/fail
Copy link
Copy Markdown
Member Author

@asottile asottile Aug 1, 2018

Choose a reason for hiding this comment

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

since I think this will probably be an applicable pattern elsewhere, I think I'll make it a first-class thing: pre-commit/pre-commit#807

Copy link
Copy Markdown
Member

@RonnyPfannschmidt RonnyPfannschmidt Aug 2, 2018

Choose a reason for hiding this comment

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

@asottile this misses the part that automatically renames them in the workdir

Copy link
Copy Markdown
Member Author

@asottile asottile Aug 2, 2018

Choose a reason for hiding this comment

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

yeah I left that as an exercise to the developer since making untracked files isn't usually a great idea (people often git add -u && !! which would untrack the file -- and generally touching the staging area seems not the best)

language: script
files: 'changelog/.*(?<!\.rst)$'
0 changelog/3745.bugfix → changelog/3745.bugfix.rst
View file
Open in desktop
File renamed without changes.
7 changes: 7 additions & 0 deletions scripts/fail
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/usr/bin/env python
"""Used by .pre-commit-config.yaml"""
import sys

if __name__ == "__main__":
print(" ".join(sys.argv[1:]))
sys.exit(1)