Skip to content

Commit 14aa1a0

Browse files
authored
doc(release): fix releasing guide (#3)
1 parent 5dd4504 commit 14aa1a0

File tree

4 files changed

+15
-6
lines changed

4 files changed

+15
-6
lines changed

.github/workflows/release-build-java.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Release Build - Java
33
on:
44
push:
55
tags:
6-
- 'release-java-v[0-9]+.[0-9]+.[0-9]+'
6+
- 'java-v[0-9]+.[0-9]+.[0-9]+'
77

88
jobs:
99
build-release-artifacts:
@@ -89,6 +89,7 @@ jobs:
8989
- uses: ncipollo/release-action@v1
9090
with:
9191
token: ${{ secrets.GITHUB_TOKEN }}
92+
name: ${{ github.ref_name }}
9293
draft: false
9394
prerelease: true
9495

@@ -102,6 +103,8 @@ jobs:
102103
## Changelog
103104
**TODO**
104105
106+
For more details please see [README.md](https://github.com/SumoLogic-Labs/sumo-opentelemetry-lambda/tree/release-${{ github.ref_name }})
107+
105108
## Lambda Function Layers:
106109
107110
${{ env.AMD64_LAYERS }}

.github/workflows/release-build-nodejs.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Release Build - NodeJS
33
on:
44
push:
55
tags:
6-
- 'release-nodejs-v[0-9]+.[0-9]+.[0-9]+'
6+
- 'nodejs-v[0-9]+.[0-9]+.[0-9]+'
77

88
jobs:
99
build-release-artifacts:
@@ -89,6 +89,7 @@ jobs:
8989
- uses: ncipollo/release-action@v1
9090
with:
9191
token: ${{ secrets.GITHUB_TOKEN }}
92+
name: ${{ github.ref_name }}
9293
draft: false
9394
prerelease: true
9495

@@ -102,6 +103,8 @@ jobs:
102103
## Changelog
103104
**TODO**
104105
106+
For more details please see [README.md](https://github.com/SumoLogic-Labs/sumo-opentelemetry-lambda/tree/release-${{ github.ref_name }})
107+
105108
## Lambda Function Layers:
106109
107110
${{ env.AMD64_LAYERS }}

.github/workflows/release-build-python.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Release Build - Python
33
on:
44
push:
55
tags:
6-
- 'release-python-v[0-9]+.[0-9]+.[0-9]+'
6+
- 'python-v[0-9]+.[0-9]+.[0-9]+'
77

88
jobs:
99
build-release-artifacts:
@@ -89,6 +89,7 @@ jobs:
8989
- uses: ncipollo/release-action@v1
9090
with:
9191
token: ${{ secrets.GITHUB_TOKEN }}
92+
name: ${{ github.ref_name }}
9293
draft: false
9394
prerelease: true
9495

@@ -102,6 +103,8 @@ jobs:
102103
## Changelog
103104
**TODO**
104105
106+
For more details please see [README.md](https://github.com/SumoLogic-Labs/sumo-opentelemetry-lambda/tree/release-${{ github.ref_name }})
107+
105108
## Lambda Function Layers:
106109
107110
${{ env.AMD64_LAYERS }}

docs/release.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Perform the following steps in order to release new verions of helm chart.
1313

1414
```bash
1515
export LANGUAGE= # Possible values: java, nodejs, or python
16-
export TAG=release-${LANGUAGE}-vx.y.z
16+
export TAG=${LANGUAGE}-vx.y.z
1717
git checkout main
1818
git pull
1919
git tag -sm "${TAG}" "${TAG}"
@@ -25,7 +25,7 @@ Perform the following steps in order to release new verions of helm chart.
2525
- branch out:
2626

2727
```bash
28-
git checkout -b "${TAG}"
28+
git checkout -b "release-${TAG}"
2929
```
3030

3131
- in specific language README.md (e.g. python/README.md)
@@ -36,7 +36,7 @@ Perform the following steps in order to release new verions of helm chart.
3636
- push branch:
3737

3838
```bash
39-
git push -u origin "${TAG}"
39+
git push -u origin "release-${TAG}"
4040
```
4141

4242
1. Create [new release][releases] based on generated pre-release draft.

0 commit comments

Comments
 (0)