Skip to content

Commit

Permalink
chore: Update release docs (#5015)
Browse files Browse the repository at this point in the history
* chore: Graduating some maintainers to Emeritus

Signed-off-by: Francisco Javier Arceo <farceo@redhat.com>

* chore: Updating release docs with overview of process

Signed-off-by: Francisco Javier Arceo <farceo@redhat.com>

* removing maintainers file change

Signed-off-by: Francisco Javier Arceo <farceo@redhat.com>

* fix formatting

Signed-off-by: Francisco Javier Arceo <farceo@redhat.com>

* fix link

Signed-off-by: Francisco Javier Arceo <farceo@redhat.com>

* removing java release

Signed-off-by: Francisco Javier Arceo <farceo@redhat.com>

---------

Signed-off-by: Francisco Javier Arceo <farceo@redhat.com>
  • Loading branch information
franciscojavierarceo authored Feb 5, 2025
1 parent 3194a11 commit 2a9585a
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions docs/project/release-process.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,44 @@
# 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
```

## Release process

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

0 comments on commit 2a9585a

Please sign in to comment.