search

python / mypy

Optional static typing for Python
https://www.mypy-lang.org/
Other
18.59k stars 2.85k forks source link

Document mypy GitHub action #11359

Open JukkaL opened 3 years ago

JukkaL commented 3 years ago

Document the mypy GitHub action definition introduced in #11320.

engrravijain commented 3 years ago

@JukkaL, I will be happy to contribute to mypy. Can you please elaborate a bit more on the requirement here and how to get started?

emmatyping commented 3 years ago

@engrravijain Our documentation is in the docs/ folder. You can also see the live version here: https://mypy.readthedocs.io/en/stable/

I think for this we would want a new page under 'Miscellaneous" that talks about the Github action, such as the inputs and a few examples of configuring its use in a workflow.

It might also be good to link to the docs about it from our README

noob8boi commented 3 years ago

Hello.. I never contributed on open source before so I am pretty confused on what to add about GitHub Action in the docs ? Like I have to write my own information based on the link provided?

SwagatSBhuyan commented 3 years ago

I would like to take on this issue, but I have a few doubts, it would be really kind of you guys to maybe guide me in the right direction. @JukkaL @ethanhs

I read up on GitHub actions, and the syntax of yaml files to make such GitHub workflows possible. My doubt is whether these workflows can be triggered by a contributor on his/her local machine, given he/she has GitHub CLI setup. Then should I make the documentation specifying the details of how to get the workflow tests running on the local system. OR, is the documentation supposed to be explaining all the workflow tests that are already there in the action yaml file, such as mypy testing, flake8, etc.? In that case, I will have to explain the inner workings of these test runs in the documentation, right? It would be much appreciated if these doubts are answered, I'm really excited to get started with this issue.

Thanks in advanced!

emmatyping commented 3 years ago

@SwagatSBhuyan This is to document the action that other people can use in their own workflows, not to document our actions workflow. You cannot (as far as I am aware) run actions locally, it is only for CI.

I'd recommend looking at the pull request Jukka mentioned as well.

SwagatSBhuyan commented 3 years ago

@SwagatSBhuyan This is to document the action that other people can use in their own workflows, not to document our actions workflow. You cannot (as far as I am aware) run actions locally, it is only for CI.

I'd recommend looking at the pull request Jukka mentioned as well.

This means I should document the making of a custom .yml for users to write their own workflows in general, right?

sobolevn commented 2 years ago

See https://github.com/python/mypy/pull/11320#issuecomment-998928568