Add twine check to GitHub Actions

[ScriptAutomate]

What does this PR do?

Runs twine check against PRs to ensure nothing is breaking.

What issues does this PR fix or reference?

Adds automated check suggested in #58727

Previous Behavior

No twine check was being done, so changes to something like README.rst could prevent twine from later publishing to PyPi further down the pipeline for a release.

New Behavior

twine check is now done against each PR, to ensure no PyPi publishing issues related to twine check happen at release.

Commits signed with GPG?

Yes

Additional Notes

This PR is dependent should only be merged once #59289 is merged, as that PR fixes the current problem with twine check failing against the README.rst file.

[bryceml]

you probably want the depth on the git checkout to include at least the last tag since salt creates different file names and version based on the last tag it finds.

It would also be good to cache the pip stuff in case pypi has issues and to lighten the load on pypi in general, maybe something like this: espressif/esptool@c325e36

it might be better to cache an entire virtual environment so pypi doesn't have to be up at all for it to work.

[Ch3LL]

@ScriptAutomate where you able to see @bryceml 's comments? Would be great to get this one in for Aluminium.

[ScriptAutomate]

you probably want the depth on the git checkout to include at least the last tag since salt creates different file names and version based on the last tag it finds.

It would also be good to cache the pip stuff in case pypi has issues and to lighten the load on pypi in general, maybe something like this: espressif/esptool@c325e36

it might be better to cache an entire virtual environment so pypi doesn't have to be up at all for it to work.

Great idea, @bryceml. That's for GitLab CI, so I poked around for how people approach this via GitHub Actions, and found a good write-up by Evan Pete Walsh / @epwalsh over at AI2:

• Python caching in GitHub Actions

Tested out, and seems to work well! I also did the following:

• Pinned to ubuntu-20.04 since GitHub Actions is planning to migrate ubuntu-latest over to it. This helped confirm it won't break on that migration.
• The cache will change if the version of Python updates, if the workflow file itself updates for twine check, or if README.rst updates.
  • twine is pinned to 3.3.0 in the workflow, but can be updated later (unless we want this pinned like >=3.3.0 instead? Cache will update anytime we choose to modify :)
• Didn't pass any args to checkout, since twine check seems focused on README.rst specifically
  • https://packaging.python.org/guides/making-a-pypi-friendly-readme/#validating-restructuredtext-markup
  • Because twine check only really cares about the README.rst file, this makes it clear we should eventually have this action migrate into a .pre-commit-config.yml call. Though, twine itself currently doesn't have a pre-commit-hook, and should. I think we'd want to get a hook into twine's repo, then we'll be able to add that pre-commit into all Python projects we are publishing to pypi (thanks to @s0undt3ch for the guidance there).

Also, the PR blocking this PR has been merged, and Twine checks pass against master! So, this PR is officially ready for review.