Merge branch 'main' into sameeran/ff-3682-use-salt-in-flag-key-hash-to-getobfuscatedprecomputedflag

Author: typotter

.github/workflows/publish.yml

@@ -8,15 +8,50 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+
+      - name: Parse version from tag
+        id: version
+        uses: release-kit/semver@v2
+
+      - name: Display Release Plan
+        if: ${{ !github.event.release.prerelease && !steps.version.outputs.prerelease }}
+        run: |
+          echo "Publishing release ${{ steps.version.outputs.full }}"
+
+      - name: Display Pre-release Plan
+        if: ${{ github.event.release.prerelease && steps.version.outputs.prerelease }}
+        run: |
+          echo "Publishing pre-relese ${{ steps.version.outputs.full }}"
+
+      - name: Validate inputs
+        if: ${{ (github.event.release.prerelease && !steps.version.outputs.prerelease) || (!github.event.release.prerelease && steps.version.outputs.prerelease) }}
+        run: |
+          RED='\033[0;31m'
+          NC='\033[0m' # No Color
+          echo -e "${RED}Pre-release label in semver but GitHub release is not marked as pre-release or vice-versa${NC}"
+          exit 1;
+
       - uses: actions/setup-node@v3
         with:
           node-version: '18.x'
       - run: yarn install
       - run: yarn test
-      - uses: JS-DevTools/npm-publish@v3
+
+      - name: Publish Latest
+        uses: JS-DevTools/npm-publish@v3
+        if: ${{ !github.event.release.prerelease && !steps.version.outputs.prerelease }}
         with:
           token: ${{ secrets.NPM_TOKEN }}
           access: public
+
+      - name: Publish Pre-release
+        uses: JS-DevTools/npm-publish@v3
+        if: ${{ github.event.release.prerelease && steps.version.outputs.prerelease }}
+        with:
+          token: ${{ secrets.NPM_TOKEN }}
+          access: public
+          tag: ${{ steps.version.outputs.prerelease }}
+
       - name: Upload npm debug log
         if: failure()  # This step will run only if the previous steps failed
         uses: actions/upload-artifact@v4

README.md

@@ -32,3 +32,21 @@ It may be useful to install the local version of this package as you develop the
 This can be done in two steps:
 1. Open the directory with the client SDK you want to add this library to, and run `make prepare`
 2. Add the local version of this library to the SDK you are developing by running `yarn add --force file:../js-client-sdk-common` (this assumes both repositories were cloned into the same directory)
+
+### Publishing Releases
+
+When publishing releases, the following rules apply:
+
+- **Standard Release**: 
+  - Create a release with tag format `vX.Y.Z` (e.g., `v4.3.5`)
+  - Keep "Set as latest release" checked
+  - Package will be published to NPM with the `latest` tag
+
+- **Pre-release**:
+  - Create a release with tag format `vX.Y.Z-label.N` (e.g., `v4.3.5-alpha.1`)
+  - Check the "Set as pre-release" option
+  - Package will be published to NPM with the pre-release label as its tag (e.g., `alpha.1`)
+
+**Note**: The release will not be published if:
+- A pre-release is marked as "latest"
+- A pre-release label is used without checking "Set as pre-release"