Merge pull request #988 from waku-org/chore/auto-release

2025-01-26 20:30:07 +00:00 · 2022-10-31 12:41:50 +11:00 · 2022-10-31 12:41:50 +11:00 · eeab832590
commit eeab832590
parent fdd617de3c 3a077cdf4b
7 changed files with 7182 additions and 21 deletions
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@ -141,3 +141,24 @@ jobs:
        with:
          name: go-waku-logs
          path: log/
+
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    needs: [check, build, proto, browser, node]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: 'lts/*'
+      - name: Install dependencies
+        run: npm ci
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release
--- a/.github/workflows/size-limit.yml
+++ b/.github/workflows/size-limit.yml
@ -11,5 +11,4 @@ jobs:
      - uses: actions/checkout@v1
      - uses: fryorcraken/size-limit-action@v2
        with:
-          skip_build: true # Done in the package.json script
          github_token: ${{ secrets.GITHUB_TOKEN }}
--- a/README.md
+++ b/README.md
@ -1,11 +1,9 @@
-[![NPM](https://nodei.co/npm/js-waku.png)](https://npmjs.org/package/js-waku)
-
-![GitHub Action](https://img.shields.io/github/workflow/status/status-im/js-waku/CI)
+![GitHub Action](https://img.shields.io/github/workflow/status/waku-org/js-waku/CI)
 [![Discord chat](https://img.shields.io/discord/864066763682218004.svg?logo=discord&colorB=7289DA)](https://discord.gg/j5pGbn7MHZ)

 # js-waku

-A JavaScript implementation of the [Waku v2 protocol](https://rfc.vac.dev/spec/10/).
+A TypeScript implementation of the [Waku v2 protocol](https://rfc.vac.dev/spec/10/).

 ## Documentation

@ -19,37 +17,34 @@ A JavaScript implementation of the [Waku v2 protocol](https://rfc.vac.dev/spec/1
 API Documentation can also be generated locally:

 ```shell
-git clone https://github.com/status-im/js-waku.git
+git clone https://github.com/waku-org/js-waku.git
 cd js-waku
 npm install
 npm run doc
 ```

-## Changelog
-
-Release changelog can be found in [CHANGELOG.md](https://github.com/status-im/js-waku/blob/master/CHANGELOG.md).
-
 ## Bugs, Questions & Features

-If you encounter any bug or would like to propose new features, feel free to [open an issue](https://github.com/status-im/js-waku/issues/new/).
+If you encounter any bug or would like to propose new features, feel free to [open an issue](https://github.com/waku-org/js-waku/issues/new/).

 For general discussion, get help or latest news, join **#js-waku** on [Vac Discord](https://discord.gg/j5pGbn7MHZ) or the [Waku Telegram Group](https://t.me/waku_org).

 ## Roadmap

-You can track progress on the [project board](https://github.com/status-im/js-waku/projects/1).
+You can track progress on the [project board](https://github.com/orgs/waku-org/projects/2/views/1).

 ## Contributing

-See [CONTRIBUTING.md](https://github.com/status-im/js-waku/blob/master/CONTRIBUTING.md).
+See [CONTRIBUTING.md](https://github.com/waku-org/js-waku/blob/master/CONTRIBUTING.md).

 ## License
+
 Licensed and distributed under either of

-* MIT license: [LICENSE-MIT](https://github.com/status-im/js-waku/blob/master/LICENSE-MIT) or http://opensource.org/licenses/MIT
+- MIT license: [LICENSE-MIT](https://github.com/waku-org/js-waku/blob/master/LICENSE-MIT) or http://opensource.org/licenses/MIT

 or

-* Apache License, Version 2.0, ([LICENSE-APACHE-v2](https://github.com/status-im/js-waku/blob/master/LICENSE-APACHE-v2) or http://www.apache.org/licenses/LICENSE-2.0)
+- Apache License, Version 2.0, ([LICENSE-APACHE-v2](https://github.com/waku-org/js-waku/blob/master/LICENSE-APACHE-v2) or http://www.apache.org/licenses/LICENSE-2.0)

 at your option. These files may not be copied, modified, or distributed except according to those terms.
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@ -14,7 +14,8 @@
    "test:browser": "lerna run test:browser",
    "test:node": "lerna run test:node",
    "proto": "lerna run proto",
-    "doc": "lerna run doc"
+    "doc": "lerna run doc",
+    "release": "lerna run --concurrency 1 release -- --"
  },
  "devDependencies": {
    "@size-limit/preset-big-lib": "^8.1.0",
@ -27,7 +28,7 @@
    "*.ts": [
      "eslint --fix"
    ],
-    "*.{ts,json,js}": [
+    "*.{ts,json,js,md}": [
      "prettier --write"
    ]
  }
--- a/packages/core/README.md
+++ b/packages/core/README.md
@ -0,0 +1,56 @@
+[![NPM](https://nodei.co/npm/@waku/core.png)](https://npmjs.org/package/@waku/core)
+
+![GitHub Action](https://img.shields.io/github/workflow/status/waku-org/js-waku/CI)
+[![Discord chat](https://img.shields.io/discord/864066763682218004.svg?logo=discord&colorB=7289DA)](https://discord.gg/j5pGbn7MHZ)
+
+# @waku/core
+
+Core components of js-waku, a TypeScript implementation of the [Waku v2 protocol](https://rfc.vac.dev/spec/10/).
+
+## Documentation
+
+- [Quick start](https://docs.wakuconnect.dev/docs/quick_start/)
+- [Full documentation](https://docs.wakuconnect.dev/)
+- [API documentation (`master` branch)](https://js.waku.org/)
+- [Waku Connect](https://wakuconnect.dev/)
+- [Waku](https://wakunetwork.com/)
+- [Vac](https://vac.dev/)
+
+API Documentation can also be generated locally:
+
+```shell
+git clone https://github.com/waku-org/js-waku.git
+cd js-waku
+npm install
+npm run doc
+```
+
+## Changelog
+
+Release changelog can be found in [CHANGELOG.md](https://github.com/waku-org/js-waku/blob/master/packages/core/CHANGELOG.md).
+
+## Bugs, Questions & Features
+
+If you encounter any bug or would like to propose new features, feel free to [open an issue](https://github.com/waku-org/js-waku/issues/new/).
+
+For general discussion, get help or latest news, join **#js-waku** on [Vac Discord](https://discord.gg/j5pGbn7MHZ) or the [Waku Telegram Group](https://t.me/waku_org).
+
+## Roadmap
+
+You can track progress on the [project board](https://github.com/orgs/waku-org/projects/2/views/1).
+
+## Contributing
+
+See [CONTRIBUTING.md](https://github.com/waku-org/js-waku/blob/master/CONTRIBUTING.md).
+
+## License
+
+Licensed and distributed under either of
+
+- MIT license: [LICENSE-MIT](https://github.com/waku-org/js-waku/blob/master/LICENSE-MIT) or http://opensource.org/licenses/MIT
+
+or
+
+- Apache License, Version 2.0, ([LICENSE-APACHE-v2](https://github.com/waku-org/js-waku/blob/master/LICENSE-APACHE-v2) or http://www.apache.org/licenses/LICENSE-2.0)
+
+at your option. These files may not be copied, modified, or distributed except according to those terms.
--- a/packages/core/package.json
+++ b/packages/core/package.json
@ -1,6 +1,6 @@
 {
  "name": "@waku/core",
-  "version": "0.0.1",
+  "version": "0.0.0-development",
  "description": "TypeScript implementation of the Waku v2 protocol",
  "types": "./dist/index.d.ts",
  "module": "./dist/index.js",
@ -53,7 +53,14 @@
    }
  },
  "type": "module",
-  "repository": "https://github.com/status-im/js-waku",
+  "homepage": "https://github.com/waku-org/js-waku/tree/master/packages/core#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/waku-org/js-waku.git"
+  },
+  "bugs": {
+    "url": "https://github.com/waku-org/js-waku/issues"
+  },
  "license": "MIT OR Apache-2.0",
  "keywords": [
    "waku",
@ -91,7 +98,8 @@
    "doc:cname": "echo 'js.waku.org' > build/docs/CNAME",
    "prepublish": "npm run build",
    "deploy": "node ci/deploy.js",
-    "reset-hard": "git clean -dfx -e .idea && git reset --hard && npm i && npm run build"
+    "reset-hard": "git clean -dfx -e .idea && git reset --hard && npm i && npm run build",
+    "release": "semantic-release"
  },
  "browser": {
    "crypto": false
@ -135,6 +143,12 @@
    "@rollup/plugin-commonjs": "^22.0.0",
    "@rollup/plugin-json": "^4.1.0",
    "@rollup/plugin-node-resolve": "^13.3.0",
+    "@semantic-release/changelog": "^6.0.1",
+    "@semantic-release/commit-analyzer": "^9.0.2",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^8.0.6",
+    "@semantic-release/npm": "^9.0.1",
+    "@semantic-release/release-notes-generator": "^10.0.3",
    "@types/app-root-path": "^1.2.4",
    "@types/chai": "^4.2.15",
    "@types/debug": "^4.1.7",
@ -172,12 +186,94 @@
    "protons": "^5.1.0",
    "puppeteer": "^13.0.1",
    "rollup": "^2.75.0",
+    "semantic-release": "^19.0.5",
    "tail": "^2.2.0",
    "ts-loader": "^9.3.1",
    "ts-node": "^10.9.1",
    "typedoc": "^0.23.10",
    "typescript": "^4.6.3"
  },
+  "release": {
+    "branches": [
+      "master"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "releaseRules": [
+            {
+              "breaking": true,
+              "release": "major"
+            },
+            {
+              "revert": true,
+              "release": "patch"
+            },
+            {
+              "type": "feat",
+              "release": "minor"
+            },
+            {
+              "type": "fix",
+              "release": "patch"
+            },
+            {
+              "type": "doc",
+              "release": "patch"
+            },
+            {
+              "type": "test",
+              "release": "patch"
+            },
+            {
+              "scope": "deps",
+              "release": "patch"
+            },
+            {
+              "scope": "no-release",
+              "release": false
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "chore",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "doc",
+                "section": "Documentation"
+              },
+              {
+                "type": "test",
+                "section": "Tests"
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      "@semantic-release/git"
+    ]
+  },
  "files": [
    "dist",
    "bundle",