Skip to content

Proposal: publish on PyPI / set up Semantic Release #31

@chanind

Description

@chanind

The circuit tracer library is already installable via pip from the git repo, so it's very close to being in a state that's publishable on PyPI. Publishing on PyPI means that other PyPI packages can rely on circuit-tracer as a dependency, and can set version restrictions with semantic versioning to communicate which upgrades are safe for users and which might be breaking changes.

I also propose setting up Semantic Release to manage packaging and deployment automatically from Github Actions. Semantic release will determine the correct version bump to apply based on the commit message in git:

  • chore: (or nothing / malformed prefix) will not bump the version or issue a deploy
  • fix: or perf: will do a patch version bump (e.g. go from v1.2.1 to v1.2.2)
  • feat: will do a minor version bump (e.g. go from v.1.2.1 to v.1.3.0)
  • adding BREAKING CHANGE: in the body of the commit will issue a major version bump (e.g from v1.2.1 to v2.0.0)

Semantic release will further automatically build and maintain a CHANGELOG.md of all past versions and what changes were included in those versions.

If this is desirable I can open a PR implementing this.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions