Skip to content

Add semantic release support and use black formatter#9

Merged
isandyawan merged 7 commits into
bps-statistics:mainfrom
im-perativa:poetry_semver_blackformatter
Oct 21, 2023
Merged

Add semantic release support and use black formatter#9
isandyawan merged 7 commits into
bps-statistics:mainfrom
im-perativa:poetry_semver_blackformatter

Conversation

@im-perativa

@im-perativa im-perativa commented Aug 7, 2023

Copy link
Copy Markdown
Contributor

This pull request introduces significant enhancements to the current Python package. It adds support for Semantic Release with GitHub Action to automate versioning, migrates existing build tools from deprecated setuptools to Poetry for better package management, and reformats the code using the Black formatter for consistent styling.

I have created a sample repository to demonstrate the development workflow after this PR is merged.

Changes introduced in this pull request:

  • Semantic Release Integration:
    GitHub Action has been integrated to automate versioning based on conventional commit messages.

  • Migration to Poetry:
    Build tools have been migrated from setuptools to Poetry, providing a more modern and efficient way of managing dependencies, builds, and publishing.

  • Code Formatting:
    The codebase has been reformatted using the Black code formatter to ensure a consistent and standardized coding style.

This PR aims to streamline the development workflow, maintain a consistent code style, and simplify package management. It also sets the groundwork for smoother and more automated future releases.

Please note that before merging this PR:

  • GH_TOKEN secret variable is added with value of a GitHub personel API token with sufficient privilege, for example:
    image

  • a v0.1.1 tag is created and published for latest commit (b0c7133) to make sure the semantic release integration can continue from current version which already published

$ git tag v0.1.1 b0c7133b9e5b91f1e6db02b47728c0eb3d2a486f
$ git push origin v1.1.0
  • Workflow permissions (Settings > Code and automation > General > Workflow permissions) has been set to read and write permissions
    image

  • PYPI_TOKEN secret variable is added with value of PyPi API token

Please review and provide feedback to ensure these changes are aligned with the project's goals and standards. Thank you!

@isandyawan isandyawan merged commit 1c62a07 into bps-statistics:main Oct 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants