This repository was archived by the owner on Sep 29, 2025. It is now read-only.
multicodec v4.0.0: generate JavaScript exports from CSV
#83
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| /** @type {import('aegir').PartialOptions} */ | ||
| module.exports = { | ||
| tsRepo: true, | ||
| release: { | ||
| build: false | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| Generate | ||
| on: | ||
| workflow_dispatch: | ||
| schedule: | ||
| - cron: '0 0 * * 0' | ||
|
|
||
| jobs: | ||
| generate: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| with: | ||
| submodules: recursive | ||
| - uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: ${{ matrix.node }} | ||
| - run: git submodule update --init --recursive --remote | ||
| - run: npm run generate | ||
| - uses: peter-evans/create-pull-request@v5 | ||
| with: | ||
| commit-message: "chore: update submodules and npm run generate" | ||
| branch: generate | ||
| title: "Changes by ${{ github.workflow }} workflow" | ||
| body: "Automated changes by [${{ github.workflow }}](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) workflow run" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,80 +1,181 @@ | ||
| name: test & maybe release | ||
| on: | ||
| push: | ||
| branches: | ||
| - master | ||
| pull_request: | ||
|
|
||
| jobs: | ||
|
|
||
| check: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: lts/* | ||
| - uses: ipfs/aegir/actions/cache-node-modules@master | ||
| - run: npm run --if-present lint | ||
| - run: npm run --if-present dep-check | ||
|
|
||
| test-node: | ||
| needs: check | ||
| runs-on: ${{ matrix.os }} | ||
| strategy: | ||
| matrix: | ||
| os: [windows-latest, ubuntu-latest, macos-latest] | ||
| node: [lts/*] | ||
| fail-fast: true | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: ${{ matrix.node }} | ||
| - uses: ipfs/aegir/actions/cache-node-modules@master | ||
| - run: npm run --if-present test:node | ||
| - uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1 | ||
| with: | ||
| flags: node | ||
|
|
||
| test-chrome: | ||
| needs: check | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: lts/* | ||
| - uses: ipfs/aegir/actions/cache-node-modules@master | ||
| - run: npm run --if-present test:chrome | ||
| - uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1 | ||
| with: | ||
| flags: chrome | ||
|
|
||
| test-chrome-webworker: | ||
| needs: check | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: lts/* | ||
| - uses: ipfs/aegir/actions/cache-node-modules@master | ||
| - run: npm run --if-present test:chrome-webworker | ||
| - uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1 | ||
| with: | ||
| flags: chrome-webworker | ||
|
|
||
| test-firefox: | ||
| needs: check | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: lts/* | ||
| - uses: ipfs/aegir/actions/cache-node-modules@master | ||
| - run: npm run --if-present test:firefox | ||
| - uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1 | ||
| with: | ||
| flags: firefox | ||
|
|
||
| test-firefox-webworker: | ||
| needs: check | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: lts/* | ||
| - uses: ipfs/aegir/actions/cache-node-modules@master | ||
| - run: npm run --if-present test:firefox-webworker | ||
| - uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1 | ||
| with: | ||
| flags: firefox-webworker | ||
|
|
||
| test-webkit: | ||
| needs: check | ||
| runs-on: ${{ matrix.os }} | ||
| strategy: | ||
| matrix: | ||
| os: [ubuntu-latest, macos-latest] | ||
| node: [lts/*] | ||
| fail-fast: true | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: lts/* | ||
| - uses: ipfs/aegir/actions/cache-node-modules@master | ||
| - run: npm run --if-present test:webkit | ||
| - uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1 | ||
| with: | ||
| flags: webkit | ||
|
|
||
| test-webkit-webworker: | ||
| needs: check | ||
| runs-on: ${{ matrix.os }} | ||
| strategy: | ||
| matrix: | ||
| os: [ubuntu-latest, macos-latest] | ||
| node: [lts/*] | ||
| fail-fast: true | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: lts/* | ||
| - uses: ipfs/aegir/actions/cache-node-modules@master | ||
| - run: npm run --if-present test:webkit-webworker | ||
| - uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1 | ||
| with: | ||
| flags: webkit-webworker | ||
|
|
||
| test-electron-main: | ||
| needs: check | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: lts/* | ||
| - uses: ipfs/aegir/actions/cache-node-modules@master | ||
| - run: npx xvfb-maybe npm run --if-present test:electron-main | ||
| - uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1 | ||
| with: | ||
| flags: electron-main | ||
|
|
||
| test-electron-renderer: | ||
| needs: check | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: lts/* | ||
| - uses: ipfs/aegir/actions/cache-node-modules@master | ||
| - run: npx xvfb-maybe npm run --if-present test:electron-renderer | ||
| - uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1 | ||
| with: | ||
| flags: electron-renderer | ||
|
|
||
| release: | ||
| needs: [test-node, test-chrome, test-chrome-webworker, test-firefox, test-firefox-webworker, test-webkit, test-webkit-webworker, test-electron-main, test-electron-renderer] | ||
| runs-on: ubuntu-latest | ||
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| with: | ||
| fetch-depth: 0 | ||
| - uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: lts/* | ||
| - uses: ipfs/aegir/actions/cache-node-modules@master | ||
| - uses: ipfs/aegir/actions/docker-login@master | ||
| with: | ||
| docker-token: ${{ secrets.DOCKER_TOKEN }} | ||
| docker-username: ${{ secrets.DOCKER_USERNAME }} | ||
| - run: npm run --if-present release | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.UCI_GITHUB_TOKEN || github.token }} | ||
| NPM_TOKEN: ${{ secrets.NPM_TOKEN }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| [submodule "multicodec"] | ||
| path = src/multicodec | ||
| url = https://github.com/multiformats/multicodec |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,32 +1,23 @@ | ||
| { | ||
| "name": "multicodec", | ||
| "version": "4.0.0", | ||
| "description": "JavaScript implementation of the multicodec specification", | ||
| "main": "src/index.js", | ||
|
There was a problem hiding this comment. I think this line needs to be changed to Also probably nice to leave the Also worth considering or investigating whether aegir will build ESM or commonjs by default and ensuring that the desired module type is output. |
||
| "files": [ | ||
| "src", | ||
| "dist" | ||
| ], | ||
| "scripts": { | ||
| "prepare": "npm run generate", | ||
| "generate": "npm run generate:json && npm run generate:typescript", | ||
| "generate:json": "csvtojson ./src/multicodec/table.csv > ./src/multicodecs.json", | ||
| "generate:typescript": "quicktype ./src/multicodecs.json -o ./src/types.d.ts --top-level 'Multicodec' --just-types --nice-property-names --explicit-unions --prefer-unions --prefer-types", | ||
| "lint": "aegir lint", | ||
| "release": "aegir release", | ||
| "build": "aegir build", | ||
| "test": "aegir test", | ||
| "test:node": "aegir test --target node", | ||
| "test:browser": "aegir test --target browser" | ||
| }, | ||
| "pre-push": [ | ||
| "lint", | ||
|
|
@@ -50,24 +41,10 @@ | |
| "url": "https://github.com/multiformats/js-multicodec/issues" | ||
| }, | ||
| "homepage": "https://github.com/multiformats/js-multicodec#readme", | ||
| "devDependencies": { | ||
| "aegir": "^39.0.9", | ||
| "csvtojson": "^2.0.10", | ||
| "quicktype": "^23.0.47" | ||
| }, | ||
| "contributors": [ | ||
| "Henrique Dias <[email protected]>", | ||
|
|
@@ -91,6 +68,7 @@ | |
| "Marcin Rataj <[email protected]>", | ||
| "Mitrasish Mukherjee <[email protected]>", | ||
| "Peter-Jan Brone <[email protected]>", | ||
| "Łukasz Magiera <[email protected]>", | ||
| "Darryl Yeo <[email protected]>" | ||
| ] | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I imagine this custom action should be replaced with our generic releaser from https://github.com/protocol/.github/blob/master/configs/js.json
See https://github.com/multiformats/js-multiaddr/tree/master/.github/workflows for prior art.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I requested this one be put here, it's based on the one @galargh helped construct over at https://github.com/multiformats/go-multicodec/blob/master/.github/workflows/go-generate.yml
if we want to make that more generic in protocol/.github then that's fine, but in lieu of a cron scheduler workflow to check for updates to multiformats/multicodec then this is probably what we need here.