Errors found in manage_python_project.ipynb notebook

[yakutovicha]

Please report here any errors or suggestions for the manage_python_project.ipynb.

[despadam]

Typo in Preparatory exercise:

• other yours or the one you have forked --> should be 'either'

[fabioacl]

In the line bumpver update --minor --dry-run it should be --dry and not --dry-run

[fabioacl]

In the Testing section, add jobs: before tests.

[edoardob90]

In the "Pre commit" section: perhaps specify that the pre-commit run --all-files requires a config file to be present.

[anates]

Executing bumpver update --minor --dry-run as proposed fails, as there is no entry for __version__ in __init__.py in mypackage. Manually adding this entry resolves the issue.

[anates]

Last entry in the notebook for publishing a new release, currently reading

- uses: softprops/[email protected]
   name: Create release

should be

    - name: Create release
      uses: softprops/[email protected]  

afaik. Is that correct?

[edoardob90]

There seems to be an issue on Windows and the yamlfmt hook. I don't know if it's reproducible every time, but it seems to be a bug in the hook script itself. Check out: jumanjihouse/pre-commit-hook-yamlfmt#25

[yakutovicha]

The exercise on releasing automation needs to be revised. It is not clear to people what is test.pypi.og and how to release things there. Maybe, it is enough to release only on GitHub.

[yakutovicha]

Last entry in the notebook for publishing a new release, currently reading

- uses: softprops/[email protected]
   name: Create release

should be

    - name: Create release
      uses: softprops/[email protected]  

afaik. Is that correct?

It should not matter, as after reading it becomes a dictionary:

{
    "name": "Create release",
    "uses": "softprops/[email protected]",
}

but I agree this way is more consistent. I will fix it.

[yakutovicha]

Executing bumpver update --minor --dry-run as proposed fails, as there is no entry for __version__ in __init__.py in mypackage. Manually adding this entry resolves the issue.

This did directly in the corresponding repo empa-scientific-it/mypackage@4393c23