COG-3546: Initial release pipeline (#1883)
<!-- .github/pull_request_template.md --> ## Description ### Inputs: `flavour`: `dev` or `main` `test_mode`: `Boolean`. Aka Dry Run. If true, it won't affect public indices or repositories ### Jobs * Create GitHub Release * Release PyPI Package * Release Docker Image [Test run](https://github.com/topoteretes/cognee/actions/runs/20167985120) <img width="551" height="149" alt="Screenshot 2025-12-12 at 14 31 06" src="https://github.com/user-attachments/assets/37648a35-0af8-4474-b051-4a81f8f8cfe7" /> #### Create GitHub Release Gets the `version` from `pyproject.toml` Creates a tag and release based on the version. The version in `pyproject.toml` **must** be already correct! If the version not updated and tag already exists - the process will take no effect and be failed. Test release was deleted. Here is the screenshot: <img width="818" height="838" alt="Screenshot 2025-12-12 at 14 19 06" src="https://github.com/user-attachments/assets/c2009f9f-1411-494e-8268-6489f6bdd959" /> #### Release PyPI Package Publishes the `dist` artifacts to pypi.org. If `test_mode` enabled - it will publish it to test.pypi.org ([example](https://test.pypi.org/project/cognee/0.5.0.dev0/)). <<< That's how I tested it. #### Release Docker Image **IMPORTANT!** Builds the image and tags it with the version from `pyproject.toml`. For example: * `cognee/cognee:0.5.1.dev0` * `cognee/cognee:0.5.1` ONLY **main** flavor adds the `latest` tag!. If a user does `docker pull cognee/cognee:latest` - the latest `main` release image will be pulled ## Type of Change <!-- Please check the relevant option --> - [ ] Bug fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update - [ ] Code refactoring - [ ] Performance improvement - [x] Other (please specify): CI ## Screenshots/Videos (if applicable) <!-- Add screenshots or videos to help explain your changes --> ## Pre-submission Checklist <!-- Please check all boxes that apply before submitting your PR --> - [ ] **I have tested my changes thoroughly before submitting this PR** - [ ] **This PR contains minimal changes necessary to address the issue/feature** - [ ] My code follows the project's coding standards and style guidelines - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have added necessary documentation (if applicable) - [ ] All new and existing tests pass - [ ] I have searched existing PRs to ensure this change hasn't been submitted already - [ ] I have linked any relevant issues in the description - [ ] My commits have clear and descriptive messages ## DCO Affirmation I affirm that all code in every commit of this pull request conforms to the terms of the Topoteretes Developer Certificate of Origin. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Chores** * Added an automated release pipeline that creates versioned GitHub releases, publishes Python packages to TestPyPI/PyPI, and builds/pushes Docker images. * Supports selectable dev/main flavors, includes flavor-specific image tagging and labels, wires version/tag outputs for downstream steps, and offers a test-mode dry run that skips external publishing. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
This commit is contained in:
commit
6b86f423ff
1 changed files with 154 additions and 0 deletions
154
.github/workflows/release.yml
vendored
Normal file
154
.github/workflows/release.yml
vendored
Normal file
|
|
@ -0,0 +1,154 @@
|
||||||
|
name: release.yml
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
flavour:
|
||||||
|
required: true
|
||||||
|
default: dev
|
||||||
|
type: choice
|
||||||
|
options:
|
||||||
|
- dev
|
||||||
|
- main
|
||||||
|
description: Dev or Main release
|
||||||
|
test_mode:
|
||||||
|
required: true
|
||||||
|
type: boolean
|
||||||
|
description: Aka Dry Run. If true, it won't affect public indices or repositories
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
release-github:
|
||||||
|
name: Create GitHub Release from ${{ inputs.flavour }}
|
||||||
|
outputs:
|
||||||
|
tag: ${{ steps.create_tag.outputs.tag }}
|
||||||
|
version: ${{ steps.create_tag.outputs.version }}
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Check out ${{ inputs.flavour }}
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
ref: ${{ inputs.flavour }}
|
||||||
|
- name: Install uv
|
||||||
|
uses: astral-sh/setup-uv@v7
|
||||||
|
|
||||||
|
- name: Create and push git tag
|
||||||
|
id: create_tag
|
||||||
|
env:
|
||||||
|
TEST_MODE: ${{ inputs.test_mode }}
|
||||||
|
run: |
|
||||||
|
VERSION="$(uv version --short)"
|
||||||
|
TAG="v${VERSION}"
|
||||||
|
|
||||||
|
echo "Tag to create: ${TAG}"
|
||||||
|
|
||||||
|
git config user.name "github-actions[bot]"
|
||||||
|
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
|
||||||
|
|
||||||
|
echo "tag=${TAG}" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
|
if [ "$TEST_MODE" = "false" ]; then
|
||||||
|
git tag "${TAG}"
|
||||||
|
git push origin "${TAG}"
|
||||||
|
else
|
||||||
|
echo "Test mode is enabled. Skipping tag creation and push."
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Create GitHub Release
|
||||||
|
uses: softprops/action-gh-release@v2
|
||||||
|
with:
|
||||||
|
tag_name: ${{ steps.create_tag.outputs.tag }}
|
||||||
|
generate_release_notes: true
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|
||||||
|
release-pypi-package:
|
||||||
|
needs: release-github
|
||||||
|
name: Release PyPI Package from ${{ inputs.flavour }}
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Check out ${{ inputs.flavour }}
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
ref: ${{ inputs.flavour }}
|
||||||
|
|
||||||
|
- name: Install uv
|
||||||
|
uses: astral-sh/setup-uv@v7
|
||||||
|
|
||||||
|
- name: Install Python
|
||||||
|
run: uv python install
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: uv sync --locked --all-extras
|
||||||
|
|
||||||
|
- name: Build distributions
|
||||||
|
run: uv build
|
||||||
|
|
||||||
|
- name: Publish ${{ inputs.flavour }} release to TestPyPI
|
||||||
|
if: ${{ inputs.test_mode }}
|
||||||
|
env:
|
||||||
|
UV_PUBLISH_TOKEN: ${{ secrets.TEST_PYPI_TOKEN }}
|
||||||
|
run: uv publish --publish-url https://test.pypi.org/legacy/
|
||||||
|
|
||||||
|
- name: Publish ${{ inputs.flavour }} release to PyPI
|
||||||
|
if: ${{ !inputs.test_mode }}
|
||||||
|
env:
|
||||||
|
UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}
|
||||||
|
run: uv publish
|
||||||
|
|
||||||
|
release-docker-image:
|
||||||
|
needs: release-github
|
||||||
|
name: Release Docker Image from ${{ inputs.flavour }}
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Check out ${{ inputs.flavour }}
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
ref: ${{ inputs.flavour }}
|
||||||
|
|
||||||
|
- name: Set up Docker Buildx
|
||||||
|
uses: docker/setup-buildx-action@v3
|
||||||
|
|
||||||
|
- name: Log in to Docker Hub
|
||||||
|
uses: docker/login-action@v3
|
||||||
|
with:
|
||||||
|
username: ${{ secrets.DOCKER_USERNAME }}
|
||||||
|
password: ${{ secrets.DOCKER_PASSWORD }}
|
||||||
|
|
||||||
|
- name: Build and push Dev Docker Image
|
||||||
|
if: ${{ inputs.flavour == 'dev' }}
|
||||||
|
uses: docker/build-push-action@v5
|
||||||
|
with:
|
||||||
|
context: .
|
||||||
|
platforms: linux/amd64,linux/arm64
|
||||||
|
push: ${{ !inputs.test_mode }}
|
||||||
|
tags: cognee/cognee:${{ needs.release-github.outputs.version }}
|
||||||
|
labels: |
|
||||||
|
version=${{ needs.release-github.outputs.version }}
|
||||||
|
flavour=${{ inputs.flavour }}
|
||||||
|
cache-from: type=registry,ref=cognee/cognee:buildcache
|
||||||
|
cache-to: type=registry,ref=cognee/cognee:buildcache,mode=max
|
||||||
|
|
||||||
|
- name: Build and push Main Docker Image
|
||||||
|
if: ${{ inputs.flavour == 'main' }}
|
||||||
|
uses: docker/build-push-action@v5
|
||||||
|
with:
|
||||||
|
context: .
|
||||||
|
platforms: linux/amd64,linux/arm64
|
||||||
|
push: ${{ !inputs.test_mode }}
|
||||||
|
tags: |
|
||||||
|
cognee/cognee:${{ needs.release-github.outputs.version }}
|
||||||
|
cognee/cognee:latest
|
||||||
|
labels: |
|
||||||
|
version=${{ needs.release-github.outputs.version }}
|
||||||
|
flavour=${{ inputs.flavour }}
|
||||||
|
cache-from: type=registry,ref=cognee/cognee:buildcache
|
||||||
|
cache-to: type=registry,ref=cognee/cognee:buildcache,mode=max
|
||||||
Loading…
Add table
Reference in a new issue