chore(cicd): Create release workflow following #366 discussion proposal 1 #369

flochaz · 2021-12-29T14:14:40Z

Description of your changes

Implement #366 proposal 1:

Pre release

trigger: On merge to main
Github commit:
- commit created with
  - No tag
  - package.json version: bumbed with preid dev (0.2.0-dev.10)
  - changelog.md: No change
Github release: NONE
npm: NONE
Doc: published under dev (see https://awslabs.github.io/aws-lambda-powertools-typescript/dev/)

Release

trigger: manually
Github commit:
- commit created with
  - git tag 0.3.0
  - package.json version bumbed with 0.3.0
  - changelog.md: extra line with changes merged since last release tag
Github release: created (0.3.0) and same data as changelog
npm: published (0.3.0)
Doc: published under (0.3.0)

Tests

Pre-release tested on a modified trigger:

https://github.com/awslabs/aws-lambda-powertools-typescript/runs/4659312586

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

Breaking change checklist

I have documented the migration process
I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

…a-powertools-typescript into feat/cicd/prodWorkflow

This reverts commit 9b3fb52.

flochaz · 2021-12-30T15:21:21Z

.github/workflows/on-release-beta.yml

+        npx lerna version --conventional-commits --conventional-prerelease --preid beta --force-publish=* --yes --no-changelog
+        git push --delete origin $(git describe --abbrev=0)
+
+        npx lerna publish from-package --no-verify-access --yes


Let's not publish to npm for intermediary version

Suggested change

npx lerna publish from-package --no-verify-access --yes

flochaz · 2021-12-30T15:39:16Z

.github/workflows/on-release-beta.yml

+        git remote set-url origin https://x-access-token:${GH_TOKEN}@github.com/$GITHUB_REPOSITORY
+
+        # Follow https://github.com/lerna/lerna/issues/2248#issuecomment-527882069 recommendation
+        npx lerna version --conventional-commits --conventional-prerelease --preid beta --force-publish=* --yes --no-changelog


Suggested change

npx lerna version --conventional-commits --conventional-prerelease --preid beta --force-publish=* --yes --no-changelog

npx lerna version --conventional-commits --conventional-prerelease --preid dev --force-publish=* --yes --no-changelog

We want changelog but populating unreleased section

flochaz · 2021-12-30T15:39:34Z

.github/workflows/on-release-prod.yml

-        else
-          npx lerna version --conventional-commits --conventional-prerelease --preid beta --create-release github --force-publish=* --yes
-        fi
+        npx lerna version --conventional-commits --conventional-graduate --create-release github --force-publish=* --yes


Suggested change

npx lerna version --conventional-commits --conventional-graduate --create-release github --force-publish=* --yes

npx lerna version --conventional-commits --conventional-graduate --preid beta --create-release github --force-publish=* --yes

need to test preid on graduate

ijemmy · 2021-12-30T15:54:24Z

.github/workflows/on-release-beta.yml

+on:
+  push:
+    branches:
+      - main


This file should be renamed to on-release-dev.yml ?

Alternatively, describing the trigger event: "on-merge-to-main"

ijemmy · 2021-12-30T15:56:15Z

.github/workflows/on-release-beta.yml

+        VERSION="${{ env.RELEASE_VERSION }}"
+        ALIAS="latest"
+        echo "Publishing doc for version: $VERSION"
+        mkdocs build
+        mike deploy --push --update-aliases "$VERSION" "$ALIAS"
+        # Set latest version as a default
+        mike set-default --push latest


Change to publish tomain.

Suggested change

VERSION="${{ env.RELEASE_VERSION }}"

ALIAS="latest"

echo "Publishing doc for version: $VERSION"

mkdocs build

mike deploy --push --update-aliases "$VERSION" "$ALIAS"

# Set latest version as a default

mike set-default --push latest

VERSION="main"

ALIAS="latest"

echo "Publishing doc for version: $VERSION"

mkdocs build

mike deploy --push --update-aliases "$VERSION" "$ALIAS"

ijemmy · 2021-12-30T15:56:51Z

.github/workflows/on-release-beta.yml

+    - name: Set RELEASE_VERSION env var
+      run: |
+        RELEASE_VERSION=$(cat packages/commons/package.json | jq '.version' -r)
+        echo "RELEASE_VERSION=${RELEASE_VERSION}" >> $GITHUB_ENV


As in discussion, let's only publish the new version when we do full release. For this one, we can just put this in main. Thus, we don't need this version number.

Suggested change

- name: Set RELEASE_VERSION env var

run: |

RELEASE_VERSION=$(cat packages/commons/package.json | jq '.version' -r)

echo "RELEASE_VERSION=${RELEASE_VERSION}" >> $GITHUB_ENV

+1 yep, as agreed during the meeting, in the "merge-to-main" process we will not publish to NPM and not create a github release

ijemmy · 2021-12-30T16:03:32Z

.github/workflows/on-release-beta.yml

+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./api
+        keep_files: true
+        destination_dir: ${{ env.RELEASE_VERSION }}/api


We'll copy the API to main/api

Suggested change

destination_dir: ${{ env.RELEASE_VERSION }}/api

destination_dir: main/api

ijemmy · 2021-12-30T16:05:17Z

.github/workflows/on-release-beta.yml

+    - name: Release API docs to the "latest" version
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./api
+        keep_files: true
+        destination_dir: latest/api 


Remove this as we don't need to copy API doc to any other folder beside main (done in the last step)

Suggested change

- name: Release API docs to the "latest" version

uses: peaceiris/actions-gh-pages@v3

with:

github_token: ${{ secrets.GITHUB_TOKEN }}

publish_dir: ./api

keep_files: true

destination_dir: latest/api

ijemmy

Approved. I have just one question.

ijemmy · 2022-01-04T12:32:48Z

.github/workflows/on-merge-to-main.yml

+        git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+        git remote set-url origin https://x-access-token:${GH_TOKEN}@github.com/$GITHUB_REPOSITORY
+
+        # Follow https://github.com/lerna/lerna/issues/2248#issuecomment-527882069 recommendation


(minor) The summary of issue you are trying to solve will be nice here.

By "recommendation", do you mean adding the --no-changelog

adding details

saragerion

Nice to have - can we incorporate this workflow: https://github.com/awslabs/aws-lambda-powertools-typescript/blob/d8fd2c1f74501ce5558057171742bd0eafdc55de/.github/workflows/release-drafter.yml
in your on-merge-to-main file here?

I know why they were implemented separated, but in my mind they are triggered by the same event and are part of the same workflow.

.github/workflows/on-merge-to-main.yml

…a-powertools-typescript into feat/cicd/prodWorkflow

…al 1 (#369)

flochaz and others added 11 commits December 29, 2021 10:58

split beta and prod workflow to release two types of package

5b723d0

chore(cicd): reet changelog

8bd063a

follow #366 discussions current proposal

84063d7

follow #366 discussions current proposal

524032b

Merge branch 'feat/cicd/prodWorkflow' of github.com:awslabs/aws-lambd…

e12d851

…a-powertools-typescript into feat/cicd/prodWorkflow

test pre-release

8a694d0

chore(release): v0.2.0-test.0 [skip ci]

9b3fb52

move back to main

33328fc

Merge branch 'feat/cicd/prodWorkflow' of github.com:awslabs/aws-lambd…

3f3076b

…a-powertools-typescript into feat/cicd/prodWorkflow

Revert "chore(release): v0.2.0-test.0 [skip ci]"

3be1be8

This reverts commit 9b3fb52.

Merge remote-tracking branch 'origin/main' into feat/cicd/prodWorkflow

5a91078

dreamorosi assigned flochaz Dec 29, 2021

dreamorosi added the automation This item relates to automation label Dec 29, 2021

dreamorosi added this to the beta-release milestone Dec 29, 2021

flochaz force-pushed the feat/cicd/prodWorkflow branch from 0852a72 to 5a91078 Compare December 29, 2021 14:43

fix tag deletion

a69f6ce

flochaz force-pushed the feat/cicd/prodWorkflow branch from c2f6170 to a69f6ce Compare December 30, 2021 15:36

flochaz commented Dec 30, 2021

View reviewed changes

flochaz mentioned this pull request Dec 30, 2021

Maintenance: Release initial beta #372

Closed

23 tasks

ijemmy suggested changes Dec 30, 2021

View reviewed changes

flochaz added 4 commits January 4, 2022 08:59

Apply lastest decisions around release proces

4012042

Merge remote-tracking branch 'origin/main' into feat/cicd/prodWorkflow

f4a3290

remove doc alias for unreleased merge PR

b32f825

rename on merge to main workflow

d8fd2c1

flochaz requested review from ijemmy and saragerion January 4, 2022 10:00

ijemmy previously approved these changes Jan 4, 2022

View reviewed changes

saragerion reviewed Jan 4, 2022

View reviewed changes

.github/workflows/on-merge-to-main.yml Show resolved Hide resolved

.github/workflows/on-merge-to-main.yml Outdated Show resolved Hide resolved

flochaz added 2 commits January 4, 2022 14:01

move release drafter to on-merge-to-main

9f8bf47

Merge branch 'feat/cicd/prodWorkflow' of github.com:awslabs/aws-lambd…

b68c5d6

…a-powertools-typescript into feat/cicd/prodWorkflow

flochaz dismissed ijemmy’s stale review via b68c5d6 January 4, 2022 13:02

saragerion approved these changes Jan 4, 2022

View reviewed changes

flochaz requested a review from ijemmy January 4, 2022 14:16

flochaz merged commit f84d0af into main Jan 4, 2022

flochaz deleted the feat/cicd/prodWorkflow branch January 4, 2022 18:28

flochaz added a commit that referenced this pull request Jan 4, 2022

chore(cicd): Create release workflow following #366 discussion propos…

05db554

…al 1 (#369)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(cicd): Create release workflow following #366 discussion proposal 1 #369

chore(cicd): Create release workflow following #366 discussion proposal 1 #369

flochaz commented Dec 29, 2021 •

edited

Loading

flochaz Dec 30, 2021

flochaz Dec 30, 2021

flochaz Dec 30, 2021

flochaz Dec 30, 2021

flochaz Dec 30, 2021

ijemmy Dec 30, 2021

saragerion Dec 30, 2021

ijemmy Dec 30, 2021

ijemmy Dec 30, 2021

saragerion Dec 30, 2021

ijemmy Dec 30, 2021

ijemmy Dec 30, 2021

ijemmy left a comment

ijemmy Jan 4, 2022

flochaz Jan 4, 2022

flochaz Jan 4, 2022

saragerion left a comment

	npx lerna version --conventional-commits --conventional-prerelease --preid beta --force-publish=* --yes --no-changelog
	npx lerna version --conventional-commits --conventional-prerelease --preid dev --force-publish=* --yes --no-changelog

	destination_dir: ${{ env.RELEASE_VERSION }}/api
	destination_dir: main/api

chore(cicd): Create release workflow following #366 discussion proposal 1 #369

chore(cicd): Create release workflow following #366 discussion proposal 1 #369

Conversation

flochaz commented Dec 29, 2021 • edited Loading

Description of your changes

Pre release

Release

Tests

PR status

Checklist

Breaking change checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ijemmy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

saragerion left a comment

Choose a reason for hiding this comment

flochaz commented Dec 29, 2021 •

edited

Loading