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

Simplifing the CI/CD process #64

Merged
merged 11 commits into from
May 21, 2023
Merged

Simplifing the CI/CD process #64

merged 11 commits into from
May 21, 2023

Conversation

davidsbatista
Copy link
Collaborator

@davidsbatista davidsbatista commented May 16, 2023

  • added GitHub workflows for:
    • code formatting
    • linting
    • type checking
    • tests
    • these all run everytime a PR is made - results here
  • using pytest and coverage only instead of tox, since I think this lib is so simple - doesn't use any 3rd party libraries - running tests on a single python version should be fine, I propose 3.8
  • added some nice badges to the README.MD
  • removing all unnecessary files
  • added a section on README.MD on how to contribute to the project
  • increased the version to 0.2.0

NOTE: if this is OK I will then open another PR with an improved README.MD + some more examples on how to use the package

After it's approved we can also generate a new pip package + review the issues, I'm sure some will be closed/tackled.

@davidsbatista davidsbatista marked this pull request as ready for review May 18, 2023 10:15
Copy link
Collaborator

@ivyleavedtoadflax ivyleavedtoadflax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good. Just one query about the Makefile. Would be good to keep these recipes, and update them as appropriate.

PYTHON_VERSION = python3.8
VIRTUALENV := .venv

.PHONY: virtualenv
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd quite like to keep these recipes if we can because they do make life a lot easier. I think we definitely don't want to be managing requirements_dev.txt manually

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can restore it for sure.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@davidsbatista davidsbatista merged commit 1740070 into main May 21, 2023
1 check passed
@davidsbatista davidsbatista deleted the NEW/setup-dev-publish-env branch June 27, 2023 10:22
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.

None yet

2 participants