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

Modernize repo #579

Merged
merged 9 commits into from
Feb 1, 2024
Merged

Modernize repo #579

merged 9 commits into from
Feb 1, 2024

Conversation

leplatrem
Copy link
Contributor

@leplatrem leplatrem commented Jan 30, 2024

  • Replaced setup.cfg and setup.py by pyproject.toml
  • Replaced flake8 by ruff
  • Use requirements.in instead of list in setup.py
  • Use version from git tag (setuptools-scm)
  • Publish to Pypi on git tag
  • Add config to categorize changes in autogenerated changelog
  • Add Github actions to dependabot
  • Update release instructions
  • Rename master to main
  • Replace tox with GH actions
  • Move package to src
  • Force labels on pull-requests (for better changelog)

Things lost with this PR:

  • No more changelog (now on GH releases)
  • Description on Pypi does not contain changelog anymore

@leplatrem leplatrem requested a review from Natim January 30, 2024 18:52
Copy link
Collaborator

@jenstroeger jenstroeger 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 @leplatrem! In case you’re looking for some inspiration, perhaps poke around our python-package-template, in particular some of the git hooks we use for checking code 🤓

A few thoughts:

pyproject.toml Outdated Show resolved Hide resolved
@leplatrem
Copy link
Contributor Author

Thanks for your feeback @jenstroeger! really appreciated!

particular some of the git hooks we use for checking code 🤓

I'm not a big fan of mandatory pre-commit hooks, I would be in favor of letting devs do that on their own

A few thoughts:

👍

Add a SECURITY policy file.

👍

Have you considered formatting with black?

We do it with ruff already 😉

The goal of this PR is to reduce the amount of efforts related to maintenance.
This repository is very low in our pile of things we maintain, and removing manual work for releasing is a tiny improvement.
I'm wondering whether we should add a warning/disclaimer about this best effort maintenance in an issue template or something....

@leplatrem leplatrem merged commit 27e80ff into main Feb 1, 2024
7 checks passed
@leplatrem leplatrem deleted the modernize-repo branch February 1, 2024 14:23
@jenstroeger
Copy link
Collaborator

@leplatrem still seeing errors with CODEOWNERS file:

Unknown owner on line 1: make sure the team @Cornices/cornice exists, is publicly visible, and has write access to the repository
*        @Cornices/cornice

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants