Merge branch 'main' into feature/DO-1285-upgrade-cdk

.github/workflows/release.yml

@@ -0,0 +1,44 @@
+name: Publish to NPM
+
+on:
+  release:
+    tags: 
+      - '**-[0-9].[0-9].[0-9]'
+      - '**-[0-9].[0-9].[0-9]-*'
+    types: [published]
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    steps:
+    # Source checkout
+    - uses: actions/checkout@v2
+      with:
+        ref: ${{ github.event.release.target_commitish }}
+    # Setting Node environment
+    - name: Setting up Node environment
+      uses: actions/setup-node@v1
+      with:
+        node-version: 16
+        registry-url: https://registry.npmjs.org/
+    # Environment configuration
+    - name: Preparing environment for release
+      run: | 
+        VERSION=$(echo $GITHUB_REF_NAME | sed 's/^.*[A-Za-z]-//g')
+        echo "VERSION=$VERSION" >> $GITHUB_ENV
+        echo "PACKAGE=$(echo $GITHUB_REF_NAME | sed "s/-${VERSION}//g")" >> $GITHUB_ENV
+    # Release process
+    - name: Release
+      run: | 
+        npm ci
+        git config --global user.name "Automated NPM Release"
+        git config --global user.email "[email protected]"
+        npm version $VERSION --allow-same-version --workspace "@aligent/cdk-${{env.PACKAGE}}"
+        npm run build --workspace "@aligent/cdk-${{env.PACKAGE}}"
+        npm test --workspace "@aligent/cdk-${{env.PACKAGE}}" --if-present
+        npm publish --access public --workspace "@aligent/cdk-${{env.PACKAGE}}"
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+    - run: git push
+      env:
+        github-token: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -11,3 +11,25 @@ Construct | Description
 [rabbitmq](packages/rabbitmq) |
 [static-hosting](packages/static-hosting) |
 [waf](packages/waf) |
+
+## Making a Release
+
+Each construct/package maintains an independent release cycle.  
+Once the changes have been approved, you can commit/merge the changes to the main branch and create a release.  
+**Note that for all the finalized releases, the source branch should be the main branch.**  
+
+If the release is experimental, you may use the `main` or the feature branch.  
+
+### Release Tags
+
+When making a release (including experimental releases), the release tag should maintain following formation.  
+
+- experimental releases: [package-name]-[version number]-[experimental tag]
+- finalized releases: [package-name]-[version number]
+
+**Note that the version number should follow `[0-9].[0-9].[0-9]` structure.**
+
+| <!-- -->      | <!-- -->      |
+|---------------|---------------|
+| Experimental  | 1.1.0-beta    |
+| Final         | 1.1.0         |