Skip to content

Commit

Permalink
Publish to Pypi (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathanbhaskar authored Nov 13, 2024
1 parent 848acbb commit cd50a31
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 3 deletions.
8 changes: 6 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@ on:

jobs:
release:
# Only run on merged PRs from release branches
if: github.event.pull_request.merged == true && startsWith(github.event.pull_request.head.ref, 'release/')
# Only run on merged PRs from release branches
runs-on: ubuntu-latest
permissions:
contents: write
id-token: write

steps:
- uses: actions/checkout@v4
Expand Down Expand Up @@ -48,4 +49,7 @@ jobs:
with:
tag_name: "v${{ steps.get-version.outputs.version }}"
generate_release_notes: true
files: dist/*
files: dist/*

- name: Publish package distributions to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.1.2] - 2024-11-13
### Added
- Pypi publishing workflow

## [0.1.1] - 2024-11-13
### Added
- Initial release
Expand Down
41 changes: 41 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Release Process

Simple guide for releasing new versions of dagster-odp.

## Creating a Release

1. Create a release branch
```bash
git checkout -b release/0.1.0
```

2. Update version in `pyproject.toml`
```toml
[project]
version = "0.1.0"
```

3. Update `CHANGELOG.md`
```markdown
# Changelog

## [0.1.0] - YYYY-MM-DD
- List your changes here
```

4. Create a PR to merge into `main`
- Title: "Release 0.1.0"
- Get review and approval

5. Merge PR
- The release workflow will automatically:
- Create a GitHub release
- Build and upload the package

## Versioning

We use [Semantic Versioning](https://semver.org/):
- MAJOR.MINOR.PATCH (e.g., 0.1.0)
- Increment MAJOR for breaking changes
- Increment MINOR for new features
- Increment PATCH for bug fixes
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "dagster-odp"
version = "0.1.1"
version = "0.1.2"
description = "A configuration-driven framework for building Dagster pipelines"
readme = "README.md"
requires-python = ">=3.9,<3.13"
Expand Down

0 comments on commit cd50a31

Please sign in to comment.