Skip to content

Commit

Permalink
Syncing from release
Browse files Browse the repository at this point in the history
  • Loading branch information
joewxboy committed Jan 6, 2025
1 parent 346242a commit 228baa0
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions docs/release/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
copyright:
years: 2023
lastupdated: "2023-08-29"
years: 2023 - 2025
lastupdated: "2025-01-02"
layout: page
title: "Building a Release"
description: "Open Horizon Release Documentation"
Expand All @@ -23,7 +23,7 @@ has_toc: true
{: #releasedocs}

<div align="left">
<img src="https://github.com/open-horizon/artwork/blob/master/white/open-horizon-white.png" alt="Badge" width="auto" height="50">
<img src="https://github.com/open-horizon/artwork/blob/master/color/open-horizon-color.png" alt="Badge" width="auto" height="50">

<h1 align="center">Building Open Horizon Releases</h1>

Expand All @@ -38,6 +38,7 @@ has_toc: true
<p align="center">
This repository is dedicated to releasing Open Horizon components and tracking their versions across repositories.
</p>
</div>

## Table of Contents

Expand Down Expand Up @@ -95,23 +96,27 @@ When it's time to create a new release for any Open Horizon component, follow th
### 2. Release Workflow Runtime Processes

- **Step 1:** Trigger Anax Release Manager.

- Triggers the release.yml workflow within the Anax repository via GitHub's REST API, passes artifact versions from the Release Version JSON
- Anax release manager pulls artifacts from its build-push.yml workflow, promotes docker images, and creates the release page for Anax
- Waits for successful completion of the Anax release.yml workflow (checked via API)

- **Step 2:** Trigger Examples Release Manager.

- Triggers the release.yml workflow within the Examples repository via GitHub's REST API, passes the entire Release Version JSON
- Examples release manager creates the tested versions file and release page
- Waits for successful completion of the Examples release.yml workflow (checked via API)

- **Step 3:** Increment Open Horizon Version.

- Depending on the select option when starting the workflow, we will increment our main Open Horzion semantic version.
- If major version is incremented, the minor and patch version are set to 0
- If minor version is incremented, the patch version is set to 0

- **Step 4:** Create Open Horizon Release.

- Creates the release page in this repository with a file that contains the released versions and links to the releases created in Open Horizon component repositories that are tied to the version of Open Horizon just released.

### 3. Celebrate New Open Horizon Release!

## Contributing
Expand All @@ -120,5 +125,4 @@ Contributions to Open Horizon Releases are welcome! If you have suggestions, bug

## License

This project is licensed under the Apache License 2.0. See [LICENSE](LICENSE) for more details.

This project is licensed under the Apache License 2.0. See [LICENSE](https://github.com/open-horizon/open-horizon-release/blob/main/LICENSE) for more details.

0 comments on commit 228baa0

Please sign in to comment.