Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Update release docs #5015

Merged
merged 6 commits into from
Feb 5, 2025
Merged
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions docs/project/release-process.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,49 @@
# Release process

The release process is automated through a GitHub Action called [release.yml](https://github.com/feast-dev/feast/blob/master/.github/workflows/release.yml).
Here's a diagram of the workflows:

```mermaid
graph LR
A[get_dry_release_versions] --> B[validate_version_bumps]
B --> C[publish-web-ui-npm]
C --> D[release]
```

The release step will trigger an automated chore commit by the CI-bot ([example](https://github.com/feast-dev/feast/commit/121617053344117cdbfbb480882b10cc176245ac)).

After the `release` step and release commit, the `publish` step will be triggered ([example](https://github.com/feast-dev/feast/actions/runs/13143995111)).

The `publish` worfklow triggers this flow:

```mermaid
graph TD
A[publish.yml] -->|triggers| B[publish_python_sdk.yml]
B -->|needs| C[publish_images.yml]
B -->|needs| D[publish_helm_charts.yml]
B -->|needs| E[publish_java_sdk.yml]

subgraph B[publish_python_sdk.yml]
direction LR
B1[Checkout code] --> B2[Set up Python] --> B3[Install dependencies] --> B4[Run tests] --> B5[Build wheels] --> B6[Publish to PyPI]
end

subgraph C[publish_images.yml]
direction LR
C1[Checkout code] --> C2[Set up Docker] --> C3[Build Docker images] --> C4[Push Docker images]
end

subgraph D[publish_helm_charts.yml]
direction LR
D1[Checkout code] --> D2[Set up Helm] --> D3[Package Helm charts] --> D4[Publish Helm charts]
end

subgraph E[publish_java_sdk.yml]
direction LR
E1[Checkout code] --> E2[Set up Java] --> E3[Build Java SDK] --> E4[Publish to Maven]
end
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we remove the java part?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed!


## Release process

For Feast maintainers, these are the concrete steps for making a new release.
Expand Down