Skip to content

Commit b7a6bf4

Browse files
author
Ramachandran Nellaiyappan
committed
[feat] README.md updated for creating release
1 parent 41de398 commit b7a6bf4

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1-
Journey Rest API
2-
3-
Steps to Release latest version:
4-
1. Create a new release with appropriate version number ["https://github.com/nramc/journey-api/releases"]
5-
2. As soon as thee release published, "maven-package-publish-workflow.yml" from the project triggered
6-
3. The workflow build and test the project
7-
4. When build successful, creates Docker image and publish it to Docker Hub
8-
5. Finally trigers Render webhook for deployment
1+
# Journey Rest API
2+
3+
4+
5+
##### Release new version:
6+
1. Manually run [Prepare Release Workflow](https://github.com/nramc/journey-api/blob/main/.github/workflows/prepare-release.yml) with release version "MAJOR.MINOR.PATCH" e.g. 0.0.1
7+
2. The Workflow flow creates a new tag with provided release version vMAJOR.MINOR.PATCH e.g. v0.0.1
8+
3. The Workflow creates [Release](https://github.com/nramc/journey-api/releases) as well with release notes and make the release as latest
9+
4. As soon Release created triggers [Release Workflow](https://github.com/nramc/journey-api/blob/main/.github/workflows/release-workflow.yml) with release event
10+
5. The Release workflow build & test project after checkout
11+
6. When build successful, creates Docker image and publish it to [Docker Hub](https://hub.docker.com/)
12+
7. Finally triggers [Render](https://dashboard.render.com/) webhook for deployment
913

1014

1115

0 commit comments

Comments
 (0)