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

Add GitHub Action Workflow and Basic Flask API Tests #38

Open
joelvaneenwyk opened this issue Dec 3, 2024 · 1 comment
Open

Add GitHub Action Workflow and Basic Flask API Tests #38

joelvaneenwyk opened this issue Dec 3, 2024 · 1 comment

Comments

@joelvaneenwyk
Copy link

joelvaneenwyk commented Dec 3, 2024

First off, love the work you've done on this project! 🙏 To ensure it continues to stand the test of time and maintain quality without lots of additional effort from you, I'd like to propose adding a GitHub Action workflow for continuous integration.

Suggested Improvements

  1. GitHub Action Workflow

    • Set up a simple GitHub Action workflow to automate testing on every pull request and commit.
    • This will help catch any issues early and maintain code quality as contributions are made.
  2. Basic Flask Tests

    • Implement a few basic Flask tests to validate key API endpoints. The github.com/joelvaneenwyk/web-extension-analysis/actions implementation added an '/version/' api to test.
    • These tests could include simple requests to endpoints to ensure they return expected statuses and responses.

This setup would help make sure that new contributions don't accidentally break the existing functionality.

See working implementation at github.com/joelvaneenwyk/web-extension-analysis/actions which I'm happy to clean up into a PR or happy to contribute in some other way too. 🍻

Notes on forked version

https://github.com/joelvaneenwyk/web-extension-analysis

  • Switched to using Rye (can remove from PR)
  • Added CSpell configs (can remove from PR)
  • Fixed numerous regex warnings
  • Refactored source into 'src' folder
  • Reformatted files with 'ruff'
@Tuhinshubhra
Copy link
Owner

@joelvaneenwyk appreciate the kind words, the project is getting a little outdated since I barely get time to maintain it. So any help would be really appreciated. Please create a pr and I'll merge it. let's remove the use of Rye.

Thanks again.

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

No branches or pull requests

2 participants