Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update react-sdk version #216

Merged
merged 30 commits into from
Jul 9, 2024
Merged

Update react-sdk version #216

Show file tree
Hide file tree
Changes from 27 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
fd5fb5f
[feat] refactor the package publication workflow (#152)
AndyBoWu Apr 25, 2024
4320c22
[test] create release (#153)
AndyBoWu Apr 25, 2024
3798d25
[feature] remove legacy workflow to create gh release (#157)
AndyBoWu Apr 26, 2024
7951c9c
Test/create release workflow (#155)
AndyBoWu Apr 26, 2024
b96a5f7
Update publish-package.yaml (#158)
AndyBoWu Apr 26, 2024
e74cd70
[fix] add condition check back
AndyBoWu May 7, 2024
a062443
Merge pull request #166 from storyprotocol/fix/add_condition_check_back
edisonz0718 May 7, 2024
bdfbc4e
Merge pull request #164 from storyprotocol/dev
edisonz0718 May 8, 2024
0f7eae1
Merge pull request #170 from storyprotocol/dev
edisonz0718 May 8, 2024
36e3d06
Fix CI syntax issue
edisonz0718 May 8, 2024
d5bf3f0
Merge pull request #171 from storyprotocol/fix-ci-syntax-issue
edisonz0718 May 8, 2024
efc2702
Merge pull request #176 from storyprotocol/dev
edisonz0718 May 11, 2024
85646df
Cenevan demo (#195)
cenevan May 17, 2024
41b1ade
Update test-slack-notifs.yml (#196)
cenevan May 17, 2024
dc2d348
Changed description and title for demo (#197)
cenevan May 17, 2024
65f9acc
Merge pull request #200 from storyprotocol/dev
edisonz0718 May 22, 2024
1a7d208
Merge pull request #207 from storyprotocol/dev
edisonz0718 Jun 1, 2024
ddfa155
Update publish-package.yml (#193)
cenevan Jun 6, 2024
f8908bb
Merge pull request #209 from storyprotocol/dev
edisonz0718 Jun 6, 2024
d7367a0
Update publish-package.yaml (#211)
cenevan Jun 6, 2024
0393af4
Merge pull request #215 from storyprotocol/dev
edisonz0718 Jul 2, 2024
d1b4685
Update publish-package.yaml (#217)
cenevan Jul 3, 2024
a81f555
Bump up react sdk to 0.0.1
bonnie57 Jul 4, 2024
5ac3cc1
Make react-sdk test's timeout longer
bonnie57 Jul 4, 2024
baf2645
Update publish-package.yaml
bonnie57 Jul 4, 2024
63571f3
Update @story-protocol/[email protected] in react sdk
bonnie57 Jul 4, 2024
31a3fb9
Fix nonce issue when run integration test
bonnie57 Jul 5, 2024
6c4520d
Update style when run npm run generate command
bonnie57 Jul 8, 2024
afb483b
Skip test about Non-Commercial Remix
bonnie57 Jul 9, 2024
231efb2
Upgrade pnpm/action-setup version
bonnie57 Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 75 additions & 17 deletions .github/workflows/publish-package.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ jobs:
needs: [Timestamp]
runs-on: ubuntu-latest
outputs:
version_to_be_published: ${{ steps.get_version_to_publish.outputs.VERSION_TO_BE_PUBLISHED }}
core_sdk_version_to_be_published: ${{ steps.get_version_to_publish.outputs.CORE_SDK_VERSION_TO_BE_PUBLISHED }}
react_sdk_version_to_be_published: ${{ steps.get_version_to_publish.outputs.REACT_SDK_VERSION_TO_BE_PUBLISHED }}
steps:
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
Expand All @@ -25,39 +26,55 @@ jobs:
id: get_version_to_publish
run: |
content=$(cat packages/core-sdk/package.json)
echo "VERSION_TO_BE_PUBLISHED=$(echo $content | jq -r '.version')" >> $GITHUB_OUTPUT
echo "CORE_SDK_VERSION_TO_BE_PUBLISHED=$(echo $content | jq -r '.version')" >> $GITHUB_OUTPUT
content=$(cat packages/react-sdk/package.json)
echo "REACT_SDK_VERSION_TO_BE_PUBLISHED=$(echo $content | jq -r '.version')" >> $GITHUB_OUTPUT

# Fetch the latest version from NPM
fetch_latest_version:
needs: [Timestamp]
runs-on: ubuntu-latest
outputs:
LATEST_VERSION: ${{ steps.get_latest_version.outputs.LATEST_VERSION }}
core_sdk_latest_version: ${{ steps.get_latest_version.outputs.CORE_SDK_LATEST_VERSION }}
react_sdk_latest_version: ${{ steps.get_latest_version.outputs.REACT_SDK_LATEST_VERSION }}
steps:
- name: Get latest package version
id: get_latest_version
run: |
LATEST_VERSION=$(npm view @story-protocol/core-sdk version)
echo "Latest version of @story-protocol/core-sdk on NPMJS is $LATEST_VERSION"
echo "LATEST_VERSION=$LATEST_VERSION" >> $GITHUB_OUTPUT

CORE_SDK_LATEST_VERSION=$(npm view @story-protocol/core-sdk version --silent)
REACT_SDK_LATEST_VERSION=$(npm view @story-protocol/react-sdk version --silent || true)
if [ -z "$REACT_SDK_LATEST_VERSION" ]; then
echo "@story-protocol/react-sdk package not found on NPMJS"
REACT_SDK_LATEST_VERSION="Not_Published"
fi
echo "Latest version of @story-protocol/core-sdk on NPMJS is $CORE_SDK_LATEST_VERSION"
echo "CORE_SDK_LATEST_VERSION=$CORE_SDK_LATEST_VERSION" >> $GITHUB_OUTPUT
echo "Latest version of @story-protocol/react-sdk on NPMJS is $REACT_SDK_LATEST_VERSION"
echo "REACT_SDK_LATEST_VERSION=$REACT_SDK_LATEST_VERSION" >> $GITHUB_OUTPUT
Comment on lines +44 to +53
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Enhance Error Handling for Fetching SDK Versions

While the script correctly fetches the latest SDK versions from NPM, it lacks robust error handling for the case where the npm view command fails. This can be critical to ensure the workflow does not proceed with incorrect or undefined version data.

+  CORE_SDK_LATEST_VERSION=$(npm view @story-protocol/core-sdk version --silent || echo "error")
+  REACT_SDK_LATEST_VERSION=$(npm view @story-protocol/react-sdk version --silent || echo "error")
+  if [ "$CORE_SDK_LATEST_VERSION" == "error" ] || [ "$REACT_SDK_LATEST_VERSION" == "error" ]; then
+    echo "Failed to fetch latest SDK versions" >&2
+    exit 1
+  fi
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
CORE_SDK_LATEST_VERSION=$(npm view @story-protocol/core-sdk version --silent)
REACT_SDK_LATEST_VERSION=$(npm view @story-protocol/react-sdk version --silent || true)
if [ -z "$REACT_SDK_LATEST_VERSION" ]; then
echo "@story-protocol/react-sdk package not found on NPMJS"
REACT_SDK_LATEST_VERSION="Not_Published"
fi
echo "Latest version of @story-protocol/core-sdk on NPMJS is $CORE_SDK_LATEST_VERSION"
echo "CORE_SDK_LATEST_VERSION=$CORE_SDK_LATEST_VERSION" >> $GITHUB_OUTPUT
echo "Latest version of @story-protocol/react-sdk on NPMJS is $REACT_SDK_LATEST_VERSION"
echo "REACT_SDK_LATEST_VERSION=$REACT_SDK_LATEST_VERSION" >> $GITHUB_OUTPUT
CORE_SDK_LATEST_VERSION=$(npm view @story-protocol/core-sdk version --silent || echo "error")
REACT_SDK_LATEST_VERSION=$(npm view @story-protocol/react-sdk version --silent || echo "error")
if [ "$CORE_SDK_LATEST_VERSION" == "error" ] || [ "$REACT_SDK_LATEST_VERSION" == "error" ]; then
echo "Failed to fetch latest SDK versions" >&2
exit 1
fi
if [ -z "$REACT_SDK_LATEST_VERSION" ]; then
echo "@story-protocol/react-sdk package not found on NPMJS"
REACT_SDK_LATEST_VERSION="Not_Published"
fi
echo "Latest version of @story-protocol/core-sdk on NPMJS is $CORE_SDK_LATEST_VERSION"
echo "CORE_SDK_LATEST_VERSION=$CORE_SDK_LATEST_VERSION" >> $GITHUB_OUTPUT
echo "Latest version of @story-protocol/react-sdk on NPMJS is $REACT_SDK_LATEST_VERSION"
echo "REACT_SDK_LATEST_VERSION=$REACT_SDK_LATEST_VERSION" >> $GITHUB_OUTPUT

# Fail the PR if the version to be published is the same as the latest version on NPM
fail_if_version_is_same:
needs: [print_version_to_publish, fetch_latest_version]
runs-on: ubuntu-latest
steps:
- name: Fail if version is the same
run: |
if [ "${{ needs.fetch_latest_version.outputs.LATEST_VERSION }}" == "${{ needs.print_version_to_publish.outputs.version_to_be_published }}" ]; then
echo "The version to be published is the same as the latest version on NPM. Exiting..."
if [ "${{ needs.fetch_latest_version.outputs.core_sdk_latest_version }}" == "${{ needs.print_version_to_publish.outputs.core_sdk_version_to_be_published }}" ]; then
echo "The core-sdk version to be published is the same as the latest version on NPM. "
fi
if [ "${{ needs.fetch_latest_version.outputs.react_sdk_latest_version }}" == "${{ needs.print_version_to_publish.outputs.react_sdk_version_to_be_published }}" ]; then
echo "The react-sdk version to be published is the same as the latest version on NPM. "
fi
if [ "${{ needs.fetch_latest_version.outputs.core_sdk_latest_version }}" == "${{ needs.print_version_to_publish.outputs.core_sdk_version_to_be_published }}" ] && [ "${{ needs.fetch_latest_version.outputs.react_sdk_latest_version }}" == "${{ needs.print_version_to_publish.outputs.react_sdk_version_to_be_published }}" ]; then
echo "The core-sdk and react-sdk versions to be published are the same as the latest versions on NPM. "
exit 1
fi

build-test-publish:
needs: [print_version_to_publish, fetch_latest_version, fail_if_version_is_same]
needs:
[print_version_to_publish, fetch_latest_version, fail_if_version_is_same]
# Skip this job if the version to be published is the same as the latest version on NPM
# and the event triggering the workflow is a push
if: needs.fetch_latest_version.outputs.LATEST_VERSION != needs.print_version_to_publish.outputs.version_to_be_published && github.event_name == 'push'
if: ${{ ((needs.fetch_latest_version.outputs.core_sdk_latest_version != needs.print_version_to_publish.outputs.core_sdk_version_to_be_published) || (needs.fetch_latest_version.outputs.react_sdk_latest_version != needs.print_version_to_publish.outputs.react_sdk_version_to_be_published)) && github.event_name == 'push'}}
runs-on: ubuntu-latest
environment: "beta-sepolia"
env:
Expand Down Expand Up @@ -110,19 +127,60 @@ jobs:

- name: Build
run: pnpm build

- name: Publish to npm
- name: Publish core-sdk package to npm
if: ${{ needs.fetch_latest_version.outputs.core_sdk_latest_version != needs.print_version_to_publish.outputs.core_sdk_version_to_be_published && github.event_name == 'push'}}
run: |
cd packages/core-sdk
npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

create_release:
needs: [print_version_to_publish, fetch_latest_version, fail_if_version_is_same]
- name: Publish react-sdk package to npm
if: ${{ needs.fetch_latest_version.outputs.react_sdk_latest_version != needs.print_version_to_publish.outputs.react_sdk_version_to_be_published && github.event_name == 'push'}}
run: |
cd packages/react-sdk
npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

create-release-core-sdk:
needs: [build-test-publish, print_version_to_publish, fetch_latest_version]
# Skip this job if the version to be published is the same as the latest version on NPM
# and the event triggering the workflow is a push
if: needs.fetch_latest_version.outputs.LATEST_VERSION != needs.print_version_to_publish.outputs.version_to_be_published && github.event_name == 'push'
if: ${{ needs.fetch_latest_version.outputs.core_sdk_latest_version != needs.print_version_to_publish.outputs.core_sdk_version_to_be_published && github.event_name == 'push'}}
uses: storyprotocol/gha-workflows/.github/workflows/reusable-create-release.yml@main
with:
version_to_publish: ${{ needs.print_version_to_publish.outputs.version_to_be_published }}
tag_name: core-sdk@${{ needs.print_version_to_publish.outputs.core_sdk_version_to_be_published }}

send_slack_notif-core-sdk:
needs: [print_version_to_publish, create-release-core-sdk]
uses: storyprotocol/gha-workflows/.github/workflows/reusable-slack-notifs.yml@main
with:
short-desc: "${{ github.repository }}: core-sdk package has been published to NPM Registry, version: ${{ needs.print_version_to_publish.outputs.core_sdk_version_to_be_published}}"
title: "Published to Registry"
img-url: "https://i.imgur.com/JHmKB0s.png"
img-alt-text: "Published to Registry"
secrets:
channel-name: ${{ secrets.SLACK_CHANNEL_ID_STORY_57BLOCKS }}
slack-bot-token: ${{ secrets.SLACK_BOT_TOKEN }}

create-release-react-sdk:
needs: [build-test-publish, print_version_to_publish, fetch_latest_version]
# Skip this job if the version to be published is the same as the latest version on NPM
# and the event triggering the workflow is a push
if: ${{ needs.fetch_latest_version.outputs.react_sdk_latest_version != needs.print_version_to_publish.outputs.react_sdk_version_to_be_published && github.event_name == 'push' }}
uses: storyprotocol/gha-workflows/.github/workflows/reusable-create-release.yml@main
with:
tag_name: react-sdk@${{ needs.print_version_to_publish.outputs.react_sdk_version_to_be_published }}

send_slack_notif-react-sdk:
needs: [print_version_to_publish, create-release-react-sdk]
uses: storyprotocol/gha-workflows/.github/workflows/reusable-slack-notifs.yml@main
with:
short-desc: "${{ github.repository }}: react-sdk package has been published to NPM Registry, version: ${{ needs.print_version_to_publish.outputs.react_sdk_version_to_be_published }}"
title: "Published to Registry"
img-url: "https://i.imgur.com/JHmKB0s.png"
img-alt-text: "Published to Registry"
secrets:
channel-name: ${{ secrets.SLACK_CHANNEL_ID_STORY_57BLOCKS }}
slack-bot-token: ${{ secrets.SLACK_BOT_TOKEN }}
16 changes: 16 additions & 0 deletions .github/workflows/test-slack-notifs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: test slack notifications

on:
workflow_dispatch:

jobs:
call-slack-notif:
uses: cenevan/gha-workflows/.github/workflows/reusable-slack-notifs.yml@main
with:
short-desc: 'https://www.npmjs.com/package/@story-protocol/core-sdk/v/1.0.0-rc.11'
title: 'Core SDK Package Published'
img-url: 'https://i.imgur.com/eqfFZRb.jpeg'
img-alt-text: 'Test alt text'
secrets:
channel-name: ${{ secrets.SLACK_CHANNEL_ID_STORY_57BLOCKS }}
slack-bot-token: ${{ secrets.SLACK_BOT_TOKEN }}
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"build": "turbo run build",
"lint": "turbo run lint",
"fix": "turbo run fix",
"test": "turbo run test --no-cache",
"test": "turbo run test --no-cache --concurrency=1",
"prepare": "husky install"
},
"devDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion packages/react-sdk/jest.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ const config = {
verbose: true,
testEnvironment: "./test/jest-environment-jsdom.ts",
setupFiles: ["./test/jest-setup.ts"],
testTimeout: 1000 * 60,
testTimeout: 1000 * 60 * 60,
};

module.exports = config;
4 changes: 2 additions & 2 deletions packages/react-sdk/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@story-protocol/react-sdk",
"version": "1.0.0-rc.14",
"version": "0.0.1",
"description": "The Story Protocol React SDK",
"main": "dist/story-protocol-react-sdk.cjs.js",
"module": "dist/story-protocol-react-sdk.esm.js",
Expand Down Expand Up @@ -63,7 +63,7 @@
},
"license": "MIT",
"dependencies": {
"@story-protocol/core-sdk": "1.0.0-rc.14",
"@story-protocol/core-sdk": "1.0.0-rc.15",
"react": "^18.3.1",
"viem": "^2.8.12"
},
Expand Down
8 changes: 4 additions & 4 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.