Skip to content

Commit

Permalink
chore: add release config and update repo name
Browse files Browse the repository at this point in the history
Updates readme and package.json with new repo name and adds release
config.
  • Loading branch information
achingbrain committed Jun 12, 2024
1 parent b4f11a3 commit 038fcec
Show file tree
Hide file tree
Showing 3 changed files with 94 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/js-test-and-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ concurrency:

jobs:
js-test-and-release:
uses: ipdxco/unified-github-workflows/.github/workflows/js-test-and-release.yml@v0.0
uses: ipdxco/unified-github-workflows/.github/workflows/js-test-and-release.yml@v1.0
secrets:
DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,27 +63,27 @@ main()
# Install

```console
$ npm i @libp2p/whatwg-fetch
$ npm i @libp2p/http-fetch
```

## Browser `<script>` tag

Loading this module through a script tag will make it's exports available as `Libp2pWhatwgFetch` in the global namespace.
Loading this module through a script tag will make it's exports available as `Libp2pHttpFetch` in the global namespace.

```html
<script src="https://unpkg.com/@libp2p/whatwg-fetch/dist/index.min.js"></script>
<script src="https://unpkg.com/@libp2p/http-fetch/dist/index.min.js"></script>
```

# API Docs

- <https://libp2p.github.io/js-libp2p-whatwg-fetch>
- <https://libp2p.github.io/js-libp2p-http-fetch>

# License

Licensed under either of

- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p-whatwg-fetch/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p-whatwg-fetch/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p-http-fetch/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p-http-fetch/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)

# Contribution

Expand Down
88 changes: 87 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,91 @@
"sourceType": "module"
}
},
"release": {
"branches": [
"main"
],
"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": "docs",
"release": "patch"
},
{
"type": "test",
"release": "patch"
},
{
"type": "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": "docs",
"section": "Documentation"
},
{
"type": "deps",
"section": "Dependencies"
},
{
"type": "test",
"section": "Tests"
}
]
}
}
],
"@semantic-release/changelog",
"@semantic-release/npm",
"@semantic-release/github",
"@semantic-release/git"
]
},
"scripts": {
"build": "aegir build",
"test": "aegir test",
Expand All @@ -50,7 +135,8 @@
"test:node": "aegir test -t node --cov",
"dep-check": "aegir dep-check",
"doc-check": "aegir doc-check",
"docs": "aegir docs"
"docs": "aegir docs",
"release": "aegir release"
},
"dependencies": {
"@libp2p/interface": "^1.2.0",
Expand Down

0 comments on commit 038fcec

Please sign in to comment.