Skip to content

RELEASE.md

Latest commit

 

History

History
61 lines (48 loc) · 2.17 KB

RELEASE.md

File metadata and controls

61 lines (48 loc) · 2.17 KB

Release and Deployment Guide

This guide consolidates the full release and deployment process for the Cloud SDK for Python, including versioning policy, preparation steps, tagging, GitHub release notes, and artifact publication.

Versioning

  • We follow SemVer: MAJOR.MINOR.PATCH (see SemVer)

Prepare the Release

  1. Create a feature branch from main

    git checkout main && git pull
git checkout -b branch-name

  2. Bump version

    • In pyproject.toml: set project.version = "X.Y.Z" (PEP 440; no leading 'v')

  3. Update changelog

    • Use the official Changelog template

  4. Commit changes

    git add pyproject.toml CHANGELOG.md
git commit -m "feat: did something"

  5. Push and open PR, get approval and merge

    git push -u origin branch-name
    • Merge commit message should follow Conventional Commits
    • Example: feat(): add xyz
    • See: Conventional Commits

Create and Publish GitHub Release

  1. Create GitHub release (this will automatically publish to PyPI)

    • Go to the repository's Releases page
    • Click "Draft a new release"
    • Choose the tag: vX.Y.Z (or create new tag from main)
    • Fill in the release title: vX.Y.Z
    • Add release notes:
      • Highlight key features and changes
      • Include breaking changes (if any)
      • Reference relevant issues/PRs
      • Use the changelog as reference
    • Click "Publish release"

  2. Automated PyPI publication

    • The Publish Package to PyPI workflow will automatically trigger
    • The workflow will:
      • Extract version from pyproject.toml
      • Check if version already exists on PyPI (prevents duplicates)
      • Build the package with uv build
      • Publish to PyPI using trusted publishing (OIDC)
    • Monitor the workflow in the Actions tab to confirm successful publication
    • Package will be available at: https://pypi.org/project/sap-cloud-sdk/X.Y.Z/

Note: The version in pyproject.toml must match the release tag (without the 'v' prefix). For example, tag vX.Y.Z requires version = "X.Y.Z" in pyproject.toml.