👷 Implement snekmate Namespaced Distribution Package (#204)

Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
pcaversaccio · Feb 9, 2024 · 6533acd · 6533acd
1 parent 887ab26
commit 6533acd
Show file tree

Hide file tree

Showing 10 changed files with 47 additions and 15 deletions.
diff --git a/.github/workflows/publish-pypi.yml b/.github/workflows/publish-pypi.yml
@@ -40,7 +40,7 @@ jobs:
           --user
 
       - name: Build a binary wheel and a source tarball
-        run: python -m build
+        run: python scripts/build.py
 
       - name: Store the distribution packages
         uses: actions/upload-artifact@v4

diff --git a/.github/workflows/publish-test-pypi.yml b/.github/workflows/publish-test-pypi.yml
@@ -37,7 +37,7 @@ jobs:
           --user
 
       - name: Build a binary wheel and a source tarball
-        run: python -m build
+        run: python scripts/build.py
 
       - name: Store the distribution packages
         uses: actions/upload-artifact@v4

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,10 @@
   - [`Math`](https://github.com/pcaversaccio/snekmate/blob/v0.0.5/src/utils/Math.vy): Rename the recently added `sign` function to `signum` to avoid any ambiguity with cryptographic signing utility functions. ([#188](https://github.com/pcaversaccio/snekmate/pull/188))
   - [`Math`](https://github.com/pcaversaccio/snekmate/blob/v0.0.5/src/utils/Math.vy): Optimise the zero point threshold in `wad_exp`. ([#189](https://github.com/pcaversaccio/snekmate/pull/189))
 
+### 🔖 Release Management
+
+- Implement `snekmate`-namespaced distribution package building for TestPyPI and PyPI. ([#204](https://github.com/pcaversaccio/snekmate/pull/204))
+
 ### 👀 Full Changelog
 
 - [`v0.0.4...v0.0.5`](https://github.com/pcaversaccio/snekmate/compare/v0.0.4...v0.0.5)

diff --git a/lib/forge-std b/lib/forge-std
diff --git a/lib/openzeppelin-contracts b/lib/openzeppelin-contracts
diff --git a/lib/solady b/lib/solady
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "snekmate",
-  "version": "0.0.5-rc.1",
+  "version": "0.0.5-rc.2",
   "description": "State-of-the-art, highly opinionated, hyper-optimised, and secure 🐍Vyper smart contract building blocks.",
   "author": "Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>",
   "license": "AGPL-3.0-only",
@@ -39,7 +39,7 @@
     "@openzeppelin/merkle-tree": "^1.0.6",
     "eslint": "^8.56.0",
     "eslint-config-prettier": "^9.1.0",
-    "ethers": "^6.10.0",
+    "ethers": "^6.11.0",
     "keccak256": "^1.0.6",
     "merkletreejs": "^0.3.11",
     "prettier": "^3.2.5",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "snekmate"
-version = "0.0.5rc1"
+version = "0.0.5rc2"
 description = "State-of-the-art, highly opinionated, hyper-optimised, and secure 🐍Vyper smart contract building blocks."
 readme = {file = "README.md", content-type = "text/markdown"}
 requires-python = ">=3.10"

diff --git a/scripts/build.py b/scripts/build.py
@@ -0,0 +1,28 @@
+import os, subprocess, shutil
+
+base_path = os.path.join(os.getcwd(), "src")
+dir_list = ["auth", "extensions", "governance", "tokens", "utils"]
+dest_build = os.path.join(base_path, "snekmate")
+
+# Create a dedicated `snekmate` directory.
+os.mkdir(dest_build)
+
+# Before generating the distribution package, move all
+# contracts to a dedicated `snekmate` directory.
+for dir in dir_list:
+    source = os.path.join(base_path, dir)
+    if os.path.isdir(source):
+        shutil.move(source, dest_build)
+
+# Build a binary wheel and a source tarball.
+subprocess.run(["python3", "-m", "build"])
+
+# After generating the distribution package, move all
+# contracts back to the original destination.
+for dir in dir_list:
+    source = os.path.join(base_path, "snekmate", dir)
+    if os.path.isdir(source):
+        shutil.move(source, base_path)
+
+# Delete the dedicated `snekmate` directory.
+shutil.rmtree(dest_build)
+5 −0		.changeset/dirty-cobras-smile.md
+5 −0		.changeset/gentle-bulldogs-turn.md
+5 −0		.changeset/nervous-pans-grow.md
+1 −1		.changeset/smart-bugs-switch.md
+0 −40		contracts/mocks/_import.sol
+1 −1		contracts/token/ERC1155/IERC1155.sol
+76 −2		contracts/utils/Arrays.sol
+1 −1		contracts/utils/Panic.sol
+3 −0		contracts/utils/README.adoc
+54 −59		contracts/utils/math/Math.sol
+11 −1		contracts/utils/math/SafeCast.sol
+16 −29		contracts/utils/structs/DoubleEndedQueue.sol
+26 −0		docs/templates/contract.hbs
+8 −0		docs/templates/properties.js
+4 −4		package-lock.json
+1 −1		package.json
+2 −2		scripts/generate/templates/Checkpoints.t.js
+14 −2		scripts/generate/templates/SafeCast.js
+3 −3		test/governance/extensions/GovernorTimelockControl.test.js
+15 −0		test/utils/Arrays.t.sol
+84 −21		test/utils/Arrays.test.js
+0 −1		test/utils/Base64.t.sol
+10 −0		test/utils/math/SafeCast.test.js
+2 −2		test/utils/structs/Checkpoints.t.sol
+8 −5		test/utils/structs/DoubleEndedQueue.test.js
+65 −55		.gas-snapshot
+1 −1		package.json
+276 −3		src/utils/LibClone.sol
+127 −152		src/utils/RedBlackTreeLib.sol
+131 −0		test/LibClone.t.sol