Merge pull request #301 from VenusProtocol/chore/slim-package

chore: publish slim package

Author: gleiser-oliveira

.github/prepare_slim_package.sh

@@ -0,0 +1,17 @@
+# Create a slim folder with the minium content we want, and remove unneeded files
+mkdir slim && cp -r artifacts* package.json README.md deployments slim && cd slim
+find deployments -mindepth 1 -depth -not -name "*_addresses.json*" -exec rm -r "{}" +
+find artifacts -mindepth 1 -depth -not -regex "artifacts/contracts.*" -exec rm -r "{}" +
+find artifacts-zk -mindepth 1 -depth -not -regex "artifacts-zk/contracts.*" -exec rm -r "{}" +
+find artifacts -mindepth 1 -depth -regex "artifacts/.*dbg\.json" -exec rm -r "{}" +
+
+# Add "-slim" to the version in the npm package, keeping the tag "-dev" if it exists
+jq '.version |= sub("^(?<core>[0-9]+\\.[0-9]+\\.[0-9]+)"; "\(.core)-slim")' package.json > package.tmp.json && mv package.tmp.json package.json
+
+# Remove the "prepare" and "postinstall" scripts, they won't work for this slim version
+jq 'del(.scripts.prepare)' package.json > package.tmp.json && mv package.tmp.json package.json
+jq 'del(.scripts.postinstall)' package.json > package.tmp.json && mv package.tmp.json package.json
+
+# Empty devDependencies and dependencies
+jq '.dependencies = {}' package.json > package.tmp.json && mv package.tmp.json package.json
+jq '.devDependencies = {}' package.json > package.tmp.json && mv package.tmp.json package.json

.github/publish_slim_package.sh

@@ -0,0 +1,10 @@
+# Set npm authentication
+echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > ~/.npmrc
+
+cd slim
+
+# Extract to PRE_RELEASE_TAG the tag in the version field of the package json, or the empty string if it doesn't exist
+PRE_RELEASE_TAG=$(jq -r '.version | if test("-") then capture("^[0-9]+\\.[0-9]+\\.[0-9]+-(?<tag>[a-zA-Z-]+)") | .tag else "" end' package.json)
+
+# Publish the package to a custom tag for slim versions
+npm publish --provenance --access public --tag $PRE_RELEASE_TAG

.github/workflows/cd.yaml

@@ -9,6 +9,8 @@ on:
 jobs:
   release:
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -35,3 +37,11 @@ jobs:
           GIT_COMMITTER_NAME: Venus Tools
           GIT_COMMITTER_EMAIL: [email protected]
         run: yarn semantic-release
+
+      - name: Prepare slim package
+        run: bash .github/prepare_slim_package.sh
+
+      - name: Publish slim package
+        run: bash .github/publish_slim_package.sh
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package.json

@@ -1,6 +1,7 @@
 {
   "name": "@venusprotocol/oracle",
   "description": "Venus Protocol Price Oracle",
+  "repository": "[email protected]:VenusProtocol/oracle.git",
   "version": "2.15.0-dev.3",
   "author": "Venus",
   "engines": {