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.

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

Jump to bottom

chore: add CI and pre-commit check for formatting and linting #116

Merged
merged 5 commits into from
Apr 9, 2024
Merged

chore: add CI and pre-commit check for formatting and linting #116

merged 5 commits into from
Apr 9, 2024

Conversation

Vyogami
Copy link
Member

@Vyogami Vyogami commented Apr 6, 2024 •
edited
Loading

  • add pre-commit hooks and github actions for formatting and linting Add ci/cd for ruff/flake8 linting #8
  • hooks include:
    • check-case-conflict
    • check-merge-conflict
    • check-toml
    • check-yaml
    • end-of-file-fixer
    • trailing-whitespace
    • ruff-format
    • prettier
  • add pre-commit as dev dependency
  • remove ruff as project dependency
  • add ruff configurations in pyproject.toml
  • add install, check and help targets
    • install: Install the poetry environment and install the pre-commit hooks
    • check: Run code quality tools using pre-commit
    • help: lists available target with short description
  • flag this project as not a "python package" by add package-mode = false
  • remove "py_ami_bot" as packages to include
  • add project description in pyproject.toml
  • change project name from py-ami-bot to Amibot-tg in pyproject.toml
  • update dependency installation and linting/formatting command in CONTRIBUTING.md

@Vyogami Vyogami force-pushed the ci/linting-formating branch 2 times, most recently from 8d4d3a9 to fb37cab Compare April 6, 2024 11:15
@Vyogami
chore(pyproject.toml): add ruff configuration and pre-commit dependency
3cc0490 
- remove ruff as dependency
- add pre-commit as dev dependency
- add ruff configurations
- remove black configurations
@Vyogami
chore(Makefile): add install, check and help targets
f009afc 
- add help target and description of all the targets
- add install target to install project dependencies and setup virtual environment
- add check target to quality check code using pre-commit hooks
- set help as default target
- remove lint and format targets as they are redundant
@Vyogami Vyogami force-pushed the ci/linting-formating branch 2 times, most recently from c6dec1e to 32f1141 Compare April 6, 2024 11:22
@Vyogami
Copy link
Member Author

Vyogami commented Apr 6, 2024

Note

Do run make check after this PR to tidy up the codebase

@achintya-7
Copy link
Member

LGTM!
@Maniktherana can you take a look as well.

@Maniktherana
Copy link
Collaborator

Nice work

@Maniktherana Maniktherana merged commit d732767 into asetalias:master Apr 9, 2024
1 check failed
@Vyogami Vyogami deleted the ci/linting-formating branch May 17, 2024 07:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@achintya-7 achintya-7 achintya-7 approved these changes

@Maniktherana Maniktherana Awaiting requested review from Maniktherana

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Vyogami @achintya-7 @Maniktherana