Skip to content

Commit cd86335

Browse files
authored
feat: readme update (#171)
* feat: readme update
1 parent 3328ecc commit cd86335

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ This repository contains reusable github workflows used in Apify projects.
66

77
Each of the workflows present in `.github/workflows` directory, unless prefixed by `local_`, is meant to be used by [caller workflows](https://docs.github.com/en/actions/using-workflows/reusing-workflows#example-caller-workflow)
88

9+
## How to release new version
10+
11+
1. Create a PR. **IMPORTANT: Avoid using the ‘chore:’ prefix, as it doesn’t work with RELEASE-PLEASE. Use ‘feat:’ or ‘fix:’ instead.**
12+
2. Merge PR into the main branch after approval. This triggers an automated workflow that generates a new PR for the release using the RELEASE-PLEASE action.
13+
3. Navigate to the PR and merge it into the main branch. This will publish the release with an updated changelog.
14+
915
## Examples
1016

1117
Build container image and push it to AWS ECR.
@@ -25,7 +31,7 @@ on:
2531
jobs:
2632
get_values:
2733
uses: apify/workflows/.github/workflows/get_values.yaml@main
28-
34+
2935
build:
3036
needs: get_values
3137
uses: apify/workflows/.github/workflows/build_docker_image_and_push_to_ecr.yaml@main

0 commit comments

Comments
 (0)