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

Update Technical Documentation for Python Hatchling Build Method #874 #875

Merged
merged 6 commits into from
Jun 25, 2024

Conversation

goessebr
Copy link
Contributor

@goessebr goessebr commented Jun 21, 2024

Issue #874

@koenedaele, @Wim-De-Clercq

Previously, our testing procedure utilized tox, as described in our documentation. However, it has been removed in commit bc77ad5.

We now employ GitHub Actions as our testing framework, configured in this workflow. This setup allows us to automatically run tests across multiple Python versions (3.10, 3.11, 3.12) on each push or pull request.

If you previously relied on tox for local testing across different Python versions, please note that this capability is no longer supported directly. Is this okay?

I need your input to decide whether to reintroduce tox or remove references to it from the documentation.

@Wim-De-Clercq
Copy link
Contributor

For me all tox functionality exists elsewhere and doesn't provide something unique anymore which would not already be covered elsewhere. So I am in favour of dropping it.

  • Running a test matrix of multiple setups and python versions: Github actions -- Sure you can't do this locally very easily. But I also don't even want to do this locally, why would I waste time running tests for several different versions. Just let CI do that and i'll dive deeper when necessary.

  • Creating a python virtualenv of a specific python version: pyenv

@goessebr goessebr marked this pull request as ready for review June 21, 2024 17:29
@goessebr goessebr requested a review from koenedaele June 21, 2024 17:29
Copy link
Member

@koenedaele koenedaele left a comment

Choose a reason for hiding this comment

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

Als alternatief voor de Travis badge lijkt er een Github workflow badge te zijn: https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge

Ik heb de nieuwe build flow getest door de docs te volgen en dat werkt. Dus voor mij in orde, maar ik heb wel graag een nieuwe badge.

@@ -5,8 +5,6 @@ Atramhasis
:target: https://pypi.python.org/pypi/atramhasis
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5801135.svg
:target: https://doi.org/10.5281/zenodo.5801135
.. image:: https://app.travis-ci.com/OnroerendErfgoed/atramhasis.svg?branch=develop
Copy link
Member

Choose a reason for hiding this comment

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

This button show the state of the tests (succes or failure), does something similar exist for Github actions?

Copy link
Contributor

Choose a reason for hiding this comment

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

@goessebr goessebr merged commit cb4f592 into develop Jun 25, 2024
4 checks passed
@goessebr goessebr deleted the feature/874_hatchling_build_documentation branch June 25, 2024 12:49
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.

3 participants