Skip to content

Commit 39f89c6

Browse files
SgtPookiSgtPooki
committed
feat: accept aegir check-project updates
Note that the README.md issue mentioned at ipfs/aegir#1056 was corrected manually
1 parent 5256ba0 commit 39f89c6

File tree

5 files changed

+125
-24
lines changed

5 files changed

+125
-24
lines changed

‎.github/dependabot.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: npm
4+
directory: "/"
5+
schedule:
6+
interval: daily
7+
time: "10:00"
8+
open-pull-requests-limit: 10
9+
commit-message:
10+
prefix: "deps"
11+
prefix-development: "deps(dev)"

‎.github/workflows/automerge.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
name: Automerge
2+
on: [ pull_request ]
3+
4+
jobs:
5+
automerge:
6+
uses: protocol/.github/.github/workflows/automerge.yml@master
7+
with:
8+
job: 'automerge'

‎.github/workflows/js-test-and-release.yml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@ name: test & maybe release
22
on:
33
push:
44
branches:
5-
- $default-branch # with #262 - ${{{ github.default_branch }}}
5+
- master # with #262 - ${{{ github.default_branch }}}
66
pull_request:
77
branches:
8-
- $default-branch # with #262 - ${{{ github.default_branch }}}
8+
- master # with #262 - ${{{ github.default_branch }}}
99

1010
jobs:
1111

1212
check:
1313
runs-on: ubuntu-latest
1414
steps:
15-
- uses: actions/checkout@v2
15+
- uses: actions/checkout@v3
1616
- uses: actions/setup-node@v2
1717
with:
1818
node-version: lts/*
@@ -29,7 +29,7 @@ jobs:
2929
node: [16]
3030
fail-fast: true
3131
steps:
32-
- uses: actions/checkout@v2
32+
- uses: actions/checkout@v3
3333
- uses: actions/setup-node@v2
3434
with:
3535
node-version: ${{ matrix.node }}
@@ -43,7 +43,7 @@ jobs:
4343
needs: check
4444
runs-on: ubuntu-latest
4545
steps:
46-
- uses: actions/checkout@v2
46+
- uses: actions/checkout@v3
4747
- uses: actions/setup-node@v2
4848
with:
4949
node-version: lts/*
@@ -57,7 +57,7 @@ jobs:
5757
needs: check
5858
runs-on: ubuntu-latest
5959
steps:
60-
- uses: actions/checkout@v2
60+
- uses: actions/checkout@v3
6161
- uses: actions/setup-node@v2
6262
with:
6363
node-version: lts/*
@@ -71,7 +71,7 @@ jobs:
7171
needs: check
7272
runs-on: ubuntu-latest
7373
steps:
74-
- uses: actions/checkout@v2
74+
- uses: actions/checkout@v3
7575
- uses: actions/setup-node@v2
7676
with:
7777
node-version: lts/*
@@ -85,7 +85,7 @@ jobs:
8585
needs: check
8686
runs-on: ubuntu-latest
8787
steps:
88-
- uses: actions/checkout@v2
88+
- uses: actions/checkout@v3
8989
- uses: actions/setup-node@v2
9090
with:
9191
node-version: lts/*
@@ -99,7 +99,7 @@ jobs:
9999
needs: check
100100
runs-on: ubuntu-latest
101101
steps:
102-
- uses: actions/checkout@v2
102+
- uses: actions/checkout@v3
103103
- uses: actions/setup-node@v2
104104
with:
105105
node-version: lts/*
@@ -113,7 +113,7 @@ jobs:
113113
needs: check
114114
runs-on: ubuntu-latest
115115
steps:
116-
- uses: actions/checkout@v2
116+
- uses: actions/checkout@v3
117117
- uses: actions/setup-node@v2
118118
with:
119119
node-version: lts/*
@@ -126,9 +126,9 @@ jobs:
126126
release:
127127
needs: [test-node, test-chrome, test-chrome-webworker, test-firefox, test-firefox-webworker, test-electron-main, test-electron-renderer]
128128
runs-on: ubuntu-latest
129-
if: github.event_name == 'push' && github.ref == 'refs/heads/$default-branch' # with #262 - 'refs/heads/${{{ github.default_branch }}}'
129+
if: github.event_name == 'push' && github.ref == 'refs/heads/master' # with #262 - 'refs/heads/${{{ github.default_branch }}}'
130130
steps:
131-
- uses: actions/checkout@v2
131+
- uses: actions/checkout@v3
132132
with:
133133
fetch-depth: 0
134134
- uses: actions/setup-node@v2

‎README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# js-kubo-rpc-client <!-- omit in toc -->
1+
# kubo-rpc-client <!-- omit in toc -->
22

33
[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io)
44
[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
55
[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs)
66
[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-kubo-rpc-client.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-kubo-rpc-client)
77
[![CI](https://img.shields.io/github/workflow/status/ipfs/js-kubo-rpc-client/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-kubo-rpc-client/actions/workflows/js-test-and-release.yml)
88

9-
> A client library for the IPFS HTTP API
9+
> A client library for the Kubo RPC API
1010
1111
## Table of contents <!-- omit in toc -->
1212

@@ -42,8 +42,8 @@
4242

4343
## Install
4444

45-
```shell
46-
$ npm i js-kubo-rpc-client
45+
```console
46+
$ npm i kubo-rpc-client
4747
```
4848

4949
<h1 align="center">
@@ -147,7 +147,7 @@ const { cid } = await client.add('Hello world!')
147147

148148
### API
149149

150-
`js-kubo-rpc-client` will not implement the [IPFS Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api). Please see https://github.com/ipfs/kubo/issues/9125 for more information.
150+
`js-kubo-rpc-client` will not implement the [IPFS Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api). Please see <https://github.com/ipfs/kubo/issues/9125> for more information.
151151

152152
### Additional Options
153153

@@ -379,12 +379,8 @@ Licensed under either of
379379

380380
## Contribute
381381

382-
Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-kubo-rpc-client/issues).
382+
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-kubo-rpc-client/issues)!
383383

384-
Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
385-
386-
Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
387-
388-
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
384+
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
389385

390386
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

‎package.json

Lines changed: 87 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@
5050
"exports": {
5151
".": {
5252
"types": "./dist/src/index.d.ts",
53-
"import": "./src/index.js"
53+
"import": "./src/index.js",
54+
"require": "./dist/src/index.js"
5455
}
5556
},
5657
"eslintConfig": {
@@ -65,6 +66,91 @@
6566
"jsdoc"
6667
]
6768
},
69+
"release": {
70+
"branches": [
71+
"master"
72+
],
73+
"plugins": [
74+
[
75+
"@semantic-release/commit-analyzer",
76+
{
77+
"preset": "conventionalcommits",
78+
"releaseRules": [
79+
{
80+
"breaking": true,
81+
"release": "major"
82+
},
83+
{
84+
"revert": true,
85+
"release": "patch"
86+
},
87+
{
88+
"type": "feat",
89+
"release": "minor"
90+
},
91+
{
92+
"type": "fix",
93+
"release": "patch"
94+
},
95+
{
96+
"type": "docs",
97+
"release": "patch"
98+
},
99+
{
100+
"type": "test",
101+
"release": "patch"
102+
},
103+
{
104+
"type": "deps",
105+
"release": "patch"
106+
},
107+
{
108+
"scope": "no-release",
109+
"release": false
110+
}
111+
]
112+
}
113+
],
114+
[
115+
"@semantic-release/release-notes-generator",
116+
{
117+
"preset": "conventionalcommits",
118+
"presetConfig": {
119+
"types": [
120+
{
121+
"type": "feat",
122+
"section": "Features"
123+
},
124+
{
125+
"type": "fix",
126+
"section": "Bug Fixes"
127+
},
128+
{
129+
"type": "chore",
130+
"section": "Trivial Changes"
131+
},
132+
{
133+
"type": "docs",
134+
"section": "Documentation"
135+
},
136+
{
137+
"type": "deps",
138+
"section": "Dependencies"
139+
},
140+
{
141+
"type": "test",
142+
"section": "Tests"
143+
}
144+
]
145+
}
146+
}
147+
],
148+
"@semantic-release/changelog",
149+
"@semantic-release/npm",
150+
"@semantic-release/github",
151+
"@semantic-release/git"
152+
]
153+
},
68154
"scripts": {
69155
"build": "aegir build",
70156
"test": "aegir test",

0 commit comments

Comments
 (0)