Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit aff50a7

Browse files
committedNov 26, 2024··
docs: add release process documentation
It is easier to read the doc rather than jump around github actions Signed-off-by: Pavel Abramov <uncle.decart@gmail.com>
1 parent 5b99f6a commit aff50a7

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed
 

‎docs/release.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Automated Release Process Documentation
2+
3+
This document outlines the automated release process for the repository. Using GitHub Actions, we ensure consistent tagging, building, and publishing of artifacts to DockerHub and GHCR.
4+
You can find workflows under `.github` directory
5+
6+
7+
## Release Workflow Overview
8+
9+
The GitHub Actions workflow automatically:
10+
11+
- Builds Docker images for the release artifact in format v.X.Y.Z
12+
- Publishes the images to:
13+
- DockerHub
14+
- GitHub Container Registry (GHCR)
15+
16+
## Automated Tagging and Publishing
17+
18+
1. Version Tagging
19+
20+
- Release tags follow the format vX.Y.Z, where:
21+
- X.Y are the major and minor versions.
22+
- Z is the iteration derived from the master branch.
23+
- Tags are automatically generated and pushed to the repository.
24+
25+
2. Build and Publish Workflow
26+
27+
The GitHub Actions workflow:
28+
29+
- Detects the creation of a new tag (v*).
30+
- Builds the Docker image for the tagged version.
31+
- Pushes the image to both DockerHub and GHCR.
32+
33+
## Key Notes
34+
35+
### Secrets Configuration
36+
37+
DockerHub Credentials: Add the following secrets to your repository:
38+
- RELEASE_DOCKERHUB_ACCOUNT
39+
- RELEASE_DOCKERHUB_TOKEN
40+
41+
GitHub Token: Ensure GITHUB_TOKEN is available for pushing to GHCR.
42+
43+
Triggering the Release Workflow
44+
45+
- Create a new tag in the repository using the vX.Y.Z format:
46+
- git tag -a v0.0.57 -m "Release version 0.0.57"
47+
- git push origin v0.0.57
48+
49+
The workflow will automatically start upon detecting the tag.
50+
51+
## Verifying the Release
52+
53+
- DockerHub: Verify the image is listed under adam DockerHub repository: https://hub.docker.com/r/lfedge/adam
54+
- GHCR: Verify the image is listed in the GitHub Packages section of adam repository: https://github.com/lf-edge/adam/packages

0 commit comments

Comments
 (0)
Please sign in to comment.