chore(cicd): Create release workflow following #366 discussion proposal 1 #369
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,94 @@ | ||||||||||||||||||||||||||
| name: release | ||||||||||||||||||||||||||
| on: | ||||||||||||||||||||||||||
| push: | ||||||||||||||||||||||||||
| branches: | ||||||||||||||||||||||||||
| - main | ||||||||||||||||||||||||||
| workflow_dispatch: {} | ||||||||||||||||||||||||||
| jobs: | ||||||||||||||||||||||||||
| publish: | ||||||||||||||||||||||||||
| runs-on: ubuntu-latest | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| steps: | ||||||||||||||||||||||||||
| - name: "Checkout" | ||||||||||||||||||||||||||
| uses: actions/checkout@v2 | ||||||||||||||||||||||||||
| with: | ||||||||||||||||||||||||||
| token: ${{ secrets.GH_PUBLISH_TOKEN }} | ||||||||||||||||||||||||||
| fetch-depth: 0 | ||||||||||||||||||||||||||
| ######################### | ||||||||||||||||||||||||||
| # Release new version | ||||||||||||||||||||||||||
| ######################### | ||||||||||||||||||||||||||
| - name: "Use NodeJS 14" | ||||||||||||||||||||||||||
| uses: actions/setup-node@v2 | ||||||||||||||||||||||||||
| with: | ||||||||||||||||||||||||||
| node-version: '14' | ||||||||||||||||||||||||||
| - name: "Setup npm" | ||||||||||||||||||||||||||
| run: | | ||||||||||||||||||||||||||
| npm set "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" | ||||||||||||||||||||||||||
| - name: Install packages | ||||||||||||||||||||||||||
| run: | | ||||||||||||||||||||||||||
| npm ci | ||||||||||||||||||||||||||
| npm run lerna-ci | ||||||||||||||||||||||||||
| - name: Run lint | ||||||||||||||||||||||||||
| run: npm run lerna-lint | ||||||||||||||||||||||||||
| - name: Run tests | ||||||||||||||||||||||||||
| run: npm run lerna-test | ||||||||||||||||||||||||||
| - name: "Version and publish" | ||||||||||||||||||||||||||
| env: | ||||||||||||||||||||||||||
| GH_TOKEN: ${{ secrets.GH_PUBLISH_TOKEN }} | ||||||||||||||||||||||||||
| run: | | ||||||||||||||||||||||||||
| git config --global user.name 'github-actions[bot]' | ||||||||||||||||||||||||||
| 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 | ||||||||||||||||||||||||||
| npx lerna version --conventional-commits --conventional-prerelease --preid beta --force-publish=* --yes --no-changelog | ||||||||||||||||||||||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. We want changelog but populating unreleased section |
||||||||||||||||||||||||||
| git push --delete origin $(git describe --abbrev=0) | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| npx lerna publish from-package --no-verify-access --yes | ||||||||||||||||||||||||||
|
There was a problem hiding this comment. Let's not publish to npm for intermediary version
Suggested change
|
||||||||||||||||||||||||||
| ######################### | ||||||||||||||||||||||||||
| # Generate documentation | ||||||||||||||||||||||||||
| ######################### | ||||||||||||||||||||||||||
| - name: Set up Python | ||||||||||||||||||||||||||
| uses: actions/[email protected] | ||||||||||||||||||||||||||
| with: | ||||||||||||||||||||||||||
| python-version: '3.8' | ||||||||||||||||||||||||||
| - name: Set RELEASE_VERSION env var | ||||||||||||||||||||||||||
| run: | | ||||||||||||||||||||||||||
| RELEASE_VERSION=$(cat packages/commons/package.json | jq '.version' -r) | ||||||||||||||||||||||||||
| echo "RELEASE_VERSION=${RELEASE_VERSION}" >> $GITHUB_ENV | ||||||||||||||||||||||||||
|
There was a problem hiding this comment. As in discussion, let's only publish the new version when we do full release. For this one, we can just put this in
Suggested change
There was a problem hiding this comment. +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 |
||||||||||||||||||||||||||
| - name: Install doc generation dependencies | ||||||||||||||||||||||||||
| run: | | ||||||||||||||||||||||||||
| pip install --upgrade pip | ||||||||||||||||||||||||||
| pip install -r docs/requirements.txt | ||||||||||||||||||||||||||
| - name: Setup doc deploy | ||||||||||||||||||||||||||
| run: | | ||||||||||||||||||||||||||
| git config --global user.name Docs deploy | ||||||||||||||||||||||||||
| git config --global user.email [email protected] | ||||||||||||||||||||||||||
| - name: Build mkdocs site in "gh-pages" branch and push | ||||||||||||||||||||||||||
| run: | | ||||||||||||||||||||||||||
| rm -rf site | ||||||||||||||||||||||||||
| 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 | ||||||||||||||||||||||||||
|
There was a problem hiding this comment. Change to publish to
Suggested change
|
||||||||||||||||||||||||||
| - name: Build API docs | ||||||||||||||||||||||||||
| run: | | ||||||||||||||||||||||||||
| rm -rf api | ||||||||||||||||||||||||||
| npm run docs-generateApiDoc | ||||||||||||||||||||||||||
| - name: Release API docs to the released version | ||||||||||||||||||||||||||
| uses: peaceiris/actions-gh-pages@v3 | ||||||||||||||||||||||||||
| with: | ||||||||||||||||||||||||||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||||||||||||||||||||||||||
| publish_dir: ./api | ||||||||||||||||||||||||||
| keep_files: true | ||||||||||||||||||||||||||
| destination_dir: ${{ env.RELEASE_VERSION }}/api | ||||||||||||||||||||||||||
|
There was a problem hiding this comment. We'll copy the API to
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 | ||||||||||||||||||||||||||
|
There was a problem hiding this comment. Remove this as we don't need to copy API doc to any other folder beside
Suggested change
|
||||||||||||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,203 +0,0 @@ | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file should be renamed to
on-release-dev.yml?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alternatively, describing the trigger event: "on-merge-to-main"