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

publish on GH release #535

Closed
wants to merge 1 commit into from
Closed

publish on GH release #535

wants to merge 1 commit into from

Conversation

dulmandakh
Copy link
Contributor

@dulmandakh dulmandakh commented Dec 25, 2020

Proposed changes

This PR make it possible to automatically publish the package to PyPI on GH release, release tag must start with v, for example v3.4.0, and will use tag name (excluding v) as version number.

You must to set PYPI_USERNAME and PYPI_PASSWORD variables in secrets to work.

It's based on my experience working on https://github.com/react-native-community/docker-android/blob/master/.github/workflows/publish.yml and https://docs.github.com/en/free-pro-team@latest/actions/guides/building-and-testing-python#publishing-to-package-registries.

@omab please review and merge

Types of changes

Please check the type of change your PR introduces:

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Code style update (PEP8, lint, formatting, renaming, etc)
  • Refactoring (no functional changes, no api changes)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Build related changes (build process, tests runner, etc)
  • [x ] Other (please describe): publish package to PyPI

Checklist

Put an x in the boxes that apply. You can also fill these out after creating
the PR. If you're unsure about any of them, don't hesitate to ask. We're here to
help! This is simply a reminder of what we are going to look for before merging
your code.

  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works

Other information

Any other information that is important to this PR such as screenshots of how
the component looks before and after the change.

@omab
Copy link
Contributor

omab commented Jan 10, 2021

I've introduced a release workflow that does this work and also:

  1. Checks that the tag properly matches the release version in the module
  2. Verifies that long descriptions will render properly on pypi (using twine)
  3. Publishes the artifacts
  4. Uses the token based authentication (no need to have my personal creds in the secrets, just a token)
  5. Uses Python 3.9

@omab omab closed this Jan 10, 2021
@dulmandakh dulmandakh deleted the gh-action-publish branch January 10, 2021 10:14
@dulmandakh
Copy link
Contributor Author

@omab good to see you back. I would like to contribute to the project.

@omab
Copy link
Contributor

omab commented Jan 10, 2021

Thanks @dulmandakh. Please take a look to #539 about contributing if you are interested in a maintainer position.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants