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

README.md: Update Development section with Nox and Nix commands #48

Merged
merged 2 commits into from
Jan 12, 2023

Conversation

jherland
Copy link
Member

@jherland jherland commented Jan 9, 2023

Rewrite the Development section completely, to document how we (in addition to Poetry) use Nox for test/workflow automation.

Also add a small, final section presenting the Nix way.

@jherland jherland added this to the First prototype milestone Jan 9, 2023
Copy link
Collaborator

@mknorps mknorps left a comment

Choose a reason for hiding this comment

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

Clean and informative <3

I tested the commands inside nix-shell, without it the program picks up some non-nox paths.

I put two sugested changes, but otherwise it is good to 🚀

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@Nour-Mws Nour-Mws left a comment

Choose a reason for hiding this comment

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

I can't comment on the Nox parts as I have yet to read the two previous PRs but the other parts read fine 👍

@jherland jherland self-assigned this Jan 12, 2023
Rewrite the Development section completely, to document how we (in
addition to Poetry) use Nox for test/workflow automation.

Also add a small, final section presenting the Nix way.
We already have appropriate directives in our pyproject.toml to control
Mypy's execution. The command-line args are unnecessary.

However, as a consequence, when we run `mypy` inside the `lint-3.*`
session in Nox, we will now _also_ perform type-checking on any Python
scripts in our top-level directory. This includes the `noxfile.py`
itself, which (since it contains an `import nox` statement) means that
Nox must also be availale in the environment when Mypy is run. Thus we
need to add Nox to the `lint` dependency group.
@jherland jherland merged commit 5731d47 into main Jan 12, 2023
@jherland jherland deleted the jherland/nox-for-local-ci branch February 8, 2023 11:30
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