search

Flexonze / django-auto-actions

Automatically generates basic Django admin actions based on your models' fields
MIT License
18 stars 4 forks source link

Add tests and `ruff` execution to GitHub Actions #3

Closed GabLeRoux closed 2 months ago

GabLeRoux commented 2 months ago

To improve code quality and catch issues early, we should add the following to the GitHub Actions workflow:

  1. Run tests: Ensure all tests are executed automatically on each push or pull request.
  2. Ruff linting: Integrate ruff to enforce consistent code style and catch linting errors.

Goal: Update the GitHub Actions configuration to run both tests and ruff on each CI run.

hammadarshad1 commented 2 months ago

It's a very great suggestion from @GabLeRoux. I can help you with this, by adding the necessary actions. Its also a good starter for me to start contributing to this cool project @Flexonze.

GabLeRoux commented 2 months ago

Most of the work is already done in #1 for this current issue, but here are some other ideas that will also improve this project:

  1. Add a build and publish step that will automatically do these things (when on a tag or a branch like release/x.x.x:
    1. Execute the desired commands to prepare the package
    2. Package the library
    3. Create a Github Release with automatic description (we can use https://github.com/softprops/action-gh-release with generate_release_notes set to true, it works very well)
    4. Publish the library on Pypy
  2. Add an action that will automatically reply to the pull-request with coverage results (increase and decrease, etc.)
    1. I think this one is good and allows doing it with coveralls https://github.com/marocchino/sticky-pull-request-comment

🙏

Flexonze commented 2 months ago

Hey @hammadarshad1! @GabLeRoux has already taken care of it, but your contribution is more than welcome! I've added a bunch of issues that would be useful if you want to take a look, or feel free to open your own issues. :smile:

hammadarshad1 commented 2 months ago

Hey @hammadarshad1! @GabLeRoux has already taken care of it, but your contribution is more than welcome! I've added a bunch of issues that would be useful if you want to take a look, or feel free to open your own issues. 😄

I'll quickly look for new issues. I would definitely love to contribute. Thanks