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

feat: simplify pre-commit hook #559

Merged
merged 22 commits into from
Feb 11, 2025
Merged

feat: simplify pre-commit hook #559

merged 22 commits into from
Feb 11, 2025

Conversation

namsnath
Copy link

@namsnath namsnath commented Feb 10, 2025

Summary of change

  • Simplifies pre-commit hooks
    • Uses pre-commit package
    • Adds hooks for general linting/syntax
    • Adds ruff hook for linting and formatting Python code
    • Adds pyright hook to be run manually, not in pre-commit stage
      • Causes issues with git integration in IDEs like VSCode
      • Runs as part of make lint
  • Updates Github Actions workflows
    • Combines PR title lint and changelog checks into single workflow
    • Updates pre-commit workflow to run pre-commit hooks + pyright
  • Moves pytest and pyright configs to pyproject.toml to clean up files
  • Updates Makefile
    • format and check-lint targets removed in favor of lint
    • set-up-hooks now sets up pre-commit
  • Lints and Formats codebase with ruff
  • pre-commit.sh not removed since there are some dependencies on it.
    • Dockerfile

Important files for review:

  • .github/workflows/*
  • .pre-commit-config.yaml
  • Makefile
  • hooks/*
  • lib64 - Seemed like a random symlink
  • pyproject.toml - Moved configs to centralize them
    • pyrightconfig.json
    • pytest.ini

Related issues

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)

Documentation changes

(If relevant, please create a PR in our docs repo, or create a checklist here highlighting the necessary changes)

Checklist for important updates

  • Changelog has been updated
  • coreDriverInterfaceSupported.json file has been updated (if needed)
    • Along with the associated array in supertokens_python/constants.py
  • frontendDriverInterfaceSupported.json file has been updated (if needed)
  • Changes to the version if needed
    • In setup.py
    • In supertokens_python/constants.py
  • Had installed and ran the pre-commit hook
  • Issue this PR against the latest non released version branch.
    • To know which one it is, run find the latest released tag (git tag) in the format vX.Y.Z, and then find the latest branch (git branch --all) whose X.Y is greater than the latest released tag.
    • If no such branch exists, then create one from the latest released branch.
  • If have added a new web framework, update the supertokens_python/utils.py file to include that in the FRAMEWORKS variable
  • If added a new recipe that has a User type with extra info, then be sure to change the User type in supertokens_python/types.py
  • Make sure that syncio / asyncio functions are consistent.
  • If access token structure has changed
    • Modified test in tests/sessions/test_access_token_version.py to account for any new claims that are optional or omitted by the core

Remaining TODOs for this PR

  • Figure out if Pyright is better run in workflows OR consider moving it to a shell script - due to issues with vscode-git integration

@namsnath namsnath self-assigned this Feb 10, 2025
@namsnath namsnath force-pushed the feat/use_pre_commit_hooks branch from 31df2b6 to 2242a1e Compare February 11, 2025 09:17
@sattvikc sattvikc merged commit ec0b729 into 0.28 Feb 11, 2025
8 of 9 checks passed
@sattvikc sattvikc deleted the feat/use_pre_commit_hooks branch February 11, 2025 12:18
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.

2 participants