Skip to content
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

Added pre-commit hooks (#498) #499

Merged
merged 6 commits into from
Apr 27, 2023
Merged

Conversation

COUR4G3
Copy link
Contributor

@COUR4G3 COUR4G3 commented Apr 20, 2023

Added pre-commit hooks for checking and updating news in projects using pre-commit (#498)

  • added towncrier-check to just check newly commited news fragments
  • added towncrier-update to actually update the news
  • added documentation section for pre-commit

Description

Added a pre-commit hooks for checking and updating news in projects using pre-commit, as suggested in my issue #498.

Checklist

  • Make sure changes are covered by existing or new tests.
  • For at least one Python version, make sure local test run is green.
  • Create a file in src/towncrier/newsfragments/. Describe your
    change and include important information. Your change will be included in the public release notes.
  • Make sure all GitHub Actions checks are green (they are automatically checking all of the above).
  • Ensure docs/tutorial.rst is still up-to-date.
  • If you add new CLI arguments (or change the meaning of existing ones), make sure docs/cli.rst reflects those changes.
  • If you add new configuration options (or change the meaning of existing ones), make sure docs/configuration.rst reflects those changes.

@COUR4G3 COUR4G3 requested a review from a team as a code owner April 20, 2023 12:23
docs/pre-commit.rst Outdated Show resolved Hide resolved
…ng pre-commit (twisted#498)

* added ``towncrier-check`` to just check newly commited news fragments
* added ``towncrier-update`` to actually update the news
* added documentation section for ``pre-commit``
Copy link
Member

@hynek hynek left a comment

Choose a reason for hiding this comment

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

Thanks! We use semantic linefeeds for docs but until #500 is merged it's not documented so I did it inline.

docs/pre-commit.rst Outdated Show resolved Hide resolved
docs/pre-commit.rst Outdated Show resolved Hide resolved
docs/pre-commit.rst Outdated Show resolved Hide resolved
@hynek hynek enabled auto-merge (squash) April 27, 2023 15:29
@hynek hynek merged commit a351582 into twisted:trunk Apr 27, 2023
@COUR4G3 COUR4G3 deleted the 498-pre-commit-hooks branch April 28, 2023 08:45
@COUR4G3 COUR4G3 mentioned this pull request Apr 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants