Set up GitHub Actions to publish to npm/crates.io (#119)

* Set up GitHub Actions to publish to npm/crates.io * Update publish-js.yml --------- Co-authored-by: Jordan Peck <[email protected]>
Auburn · Oct 6, 2023 · e1a694d · e1a694d
1 parent 8facc71
commit e1a694d
Show file tree

Hide file tree

Showing 5 changed files with 63 additions and 8 deletions.
diff --git a/.github/workflows/publish-js.yml b/.github/workflows/publish-js.yml
@@ -0,0 +1,28 @@
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - 'JavaScript/package.json' # The version number must be bumped in order to publish to npm
+  workflow_dispatch:
+
+name: Publish to npm
+
+jobs:
+  publish:
+    name: Publish
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Publish to npm
+        run: cd JavaScript && npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NODE_AUTH_TOKEN }}
diff --git a/.github/workflows/publish-rust.yml b/.github/workflows/publish-rust.yml
@@ -0,0 +1,28 @@
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - 'Rust/Cargo.toml' # The version number must be bumped in order to publish to crates.io
+
+name: Publish Rust (crates.io)
+
+jobs:
+  publish:
+    name: Publish to crates.io
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Install Rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+
+      - name: Publish to crates.io
+        run: cd Rust && cargo publish
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
diff --git a/JavaScript/FastNoiseLite.js b/JavaScript/FastNoiseLite.js
@@ -49,8 +49,8 @@
 // https://www.npmjs.com/package/fastnoise-lite
 // https://discord.gg/SHVaVfV
 //
-// Ported to JavaScript by storm (Patrick U):
-// Discord: storm#8888 (preferred) | Email: [email protected] | GitHub: stormy482 (https://github.com/stormy482)
+// Ported to JavaScript by Stormy482 (Patrick U):
+// Discord: dev_storm (preferred) | Email: [email protected] | GitHub: stormy482 (https://github.com/stormy482)
 //
 
 

diff --git a/JavaScript/README.md b/JavaScript/README.md
@@ -48,12 +48,12 @@ for (let y = 0; y < 128; y++) {
 Since JavaScript does not support method overloading it has been simulated to make the user experience more continuous
 between language versions.
 
-Some of the code has been changed to use switch statments since it provided a minor preformance boost in some small 
+Some of the code has been changed to use switch statements since it provided a minor performance boost in some small 
 frequently used places eg the _Hash methods.
 
 Here is a template for the method overloading:
 
-```javascript
+```js
 class FastNoiseLite {
     /**
      * JSdoc
@@ -77,7 +77,6 @@ class FastNoiseLite {
     }
 
 }
-
 ```
 
-### DM storm#8888 on discord or email w/ any questions or need any support or ask someone in our discord :D
+### DM dev_storm on discord or email w/ any questions or need any support or ask someone in our discord :D
diff --git a/JavaScript/package.json b/JavaScript/package.json
@@ -2,7 +2,7 @@
   "name": "fastnoise-lite",
   "type": "module",
   "version": "1.0.1",
-  "description": "an extremely portable open source noise generation library with a large selection of noise algorithms",
+  "description": "FastNoiseLite Lite is an extremely portable open source noise generation library with a large selection of noise algorithms",
   "main": "FastNoiseLite.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -32,7 +32,7 @@
     "random",
     "generative"
   ],
-  "author": "Patrick U & Jordan Peck",
+  "contributors": ["Patrick U", "Jordan Peck"],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/Auburn/FastNoiseLite/issues"