Skip to content

Commit fab53fb

Browse files
committed
docs: how to manual release steps are added
1 parent ea59da9 commit fab53fb

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,33 @@ Follow these steps to make a contribution to the project:
104104
```
105105
- Create a GitHub pull request, selecting `main` as the target branch
106106

107+
## Releases
108+
109+
### Manual Release
110+
Releases must be triggered manually by an approver. This can be done either via `GitHub Actions` (workflow dispatch) or through the `GitHub Releases` page using the **Draft a new release** option. The *Release Manual* workflow is responsible for creating and completing the release.
111+
112+
Option 1: Release via Workflow Dispatch
113+
114+
- Go to Actions and select the *Release Manual* workflow.
115+
116+
- Click **Run workflow**.
117+
118+
- Enter the next incremented version number with the v prefix (for example, v1.2.3).
119+
120+
- The workflow will create the release and upload the build artifacts once completed.
121+
122+
Option 2: Release via Draft Release
123+
124+
- Go to Releases and click **Draft a new release**.
125+
126+
- Create a new tag using the next incremented version with the v prefix.
127+
128+
- Fill in the release title and description.
129+
130+
- Click Publish release.
131+
132+
- The release will appear immediately on the Releases page. This action will also trigger the *Release Manual* workflow, which will build the artifacts and upload them to the published release once the workflow finishes.
133+
107134

108135
## Notes
109136
These commit IDs represent the last migration checkpoint from each provider's original repository, marking the final commit that was copied during the consolidation process.

0 commit comments

Comments
 (0)