Skip to main content

Test Python Library

Project description

Test Python Library

Library used to test a new simplified release flow.

Development

A suggested method of development is to use git worktrees.

  1. From a personal fork, create a new worktree for the bug, feature or chore.

git worktree add feature-a

  1. Implement the code changes and commit.

  2. Update the CHANGELOG.md to include the change in the "Unreleased" section.

  3. Commit, push and create a PR to the upstream repository's main branch.

  4. Solicit a code-read from another team member.

  5. Upon approval, squash and merge to main.

  6. (optional) cleanup by removing the worktree and associated local and remote branch.

If the version was incremented in pyproject.toml, the merge to the main branch will trigger a release to test PyPI (but not production PyPI).

Releasing

Only create a release for actual library updates. Things that do not warrant a release:

  • Repository metadata such as README updates, workflow changes, etc.
  • Cleanup/refactors
  1. Create a new branch "release-x.y.z" When incrementing, follow Semantic Versioning standard.

    • Bug fixes: ++ patch version
    • Features: ++ minor version
    • Breaking Changes: ++ major version
  2. Update pyproject.toml with the new version.

  3. Update CHANGELOG.md by moving the "Unreleased" items into a new section for the given version (leaving an empty Unreleased section as a template for future updates)

  4. Commit, push and create a PR to upstream's main branch Please set the commit message to "Release vx.y.z" with the new version number

  5. Obtain approval for release from another team member.

  6. Squash and merge (ensure the commit message remains Release vx.y.x).

  7. Verify the new version was correctly published to test PyPI and all precautions have been taken to ensure it is functioning as intended.

  8. Pull from upstream into your local main branch and tag the commit vx.y.z (the squash and merge will have created a new commit hash)

  9. push the tag to upstream, triggering the release to production PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lkingland_test_pylib-0.1.3.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

lkingland_test_pylib-0.1.3-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

Details for the file lkingland_test_pylib-0.1.3.tar.gz.

File metadata

  • Download URL: lkingland_test_pylib-0.1.3.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for lkingland_test_pylib-0.1.3.tar.gz
Algorithm Hash digest
SHA256 fa8f5e8a80c7f3806abeef8f55208b634bc04d2b37c3d507a87a11b154b44c2a
MD5 a109e0076e75bc824d35dcf659fd6edb
BLAKE2b-256 e8b4790b386e615faf83c777cdea5bd0f8526e027ab75c8bbacd7dc5ab4d003e

See more details on using hashes here.

File details

Details for the file lkingland_test_pylib-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for lkingland_test_pylib-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7635bcf0d6c9ab7c86558c70bdf21e8d0fb3702fd34a07e54fe876425de01aa0
MD5 4e20f2db291d1dd4b02f39c60a32e14a
BLAKE2b-256 16be51702a0242d05f365e8c6bfbdbe0563f3006846a49ca246ef8adcb83d6a5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page