From 5c7e42ef02e9c9f8a509905fb22589107b158d2c Mon Sep 17 00:00:00 2001 From: achingbrain Date: Tue, 23 Apr 2024 14:06:34 +0100 Subject: [PATCH] chore: rename master to main --- .github/workflows/js-test-and-release.yml | 2 +- CONTRIBUTING.md | 86 ----------------------- README.md | 4 +- package.json | 2 +- 4 files changed, 4 insertions(+), 90 deletions(-) delete mode 100644 CONTRIBUTING.md diff --git a/.github/workflows/js-test-and-release.yml b/.github/workflows/js-test-and-release.yml index d31e05809..280681349 100644 --- a/.github/workflows/js-test-and-release.yml +++ b/.github/workflows/js-test-and-release.yml @@ -3,7 +3,7 @@ name: test & maybe release on: push: branches: - - master + - main pull_request: workflow_dispatch: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 4082852d7..000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,86 +0,0 @@ -# Contributing - -## Setup - -You should have [node.js] and [npm] installed. - -## Linting - -Linting is done using [eslint] and the rules are based on [standard]. - -```bash -$ npm run lint -``` - -## Tests - -Tests in node - -```bash -$ npm run test:node -``` - -Tests in the browser - -```bash -$ npm run test:browser -``` - -### Writing a new core interface test - -NOTE: The below instructions are out of date and will be updated eventually. Please follow https://github.com/ipfs/kubo/issues/9125 for more information. - -The core interface tests are kept in a separate repo, because they are used by multiple other projects. To add a core interface test, follow this guide: - -1. Clone this project repo and the interface core tests repo: - * `git clone https://github.com/ipfs/js-ipfs-http-client.git` - * `git clone https://github.com/ipfs/interface-js-ipfs-core.git` -1. Install dependencies and globally [link](https://docs.npmjs.com/cli/link) the interface core tests: - * `cd interface-js-ipfs-core` - * `npm install` - * `npm link` -1. Write your test -1. Install dependencies for this project and link to the interface core tests - * `cd ../js-ipfs-http-client` - * `npm install` - * `npm link interface-ipfs-core` -1. Run the tests: - * `npm test` - -Next: - -1. Send a PR to `ipfs/interface-js-ipfs-core` (please also add to the documentation!) -1. This will be reviewed by a core contributor and they will perform the same steps as above -1. When merged, a new version of `interface-ipfs-core` will be released -1. Finally, a PR needs to be created or updated to `ipfs/js-ipfs-http-client` to use the new version - -## Building browser version - -```bash -$ npm run build -``` - -## Releases - -The `release` task will - -1. Run a build -2. Commit the build -3. Bump the version in `package.json` -4. Commit the version change -5. Create a git tag -6. Run `git push` to `upstream/master` (You can change this with `--remote my-remote`) - -```bash -# Major release -$ npm run release-major -# Minor relase -$ npm run release-minor -# Patch release -$ npm run release -``` - -[node.js]: https://nodejs.org/ -[npm]: http://npmjs.org/ -[eslint]: http://eslint.org/ -[standard]: https://github.com/feross/standard diff --git a/README.md b/README.md index e708d2202..6e1fea787 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech) [![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech) [![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) -[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-kubo-rpc-client/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/ipfs/js-kubo-rpc-client/actions/workflows/js-test-and-release.yml?query=branch%3Amaster) +[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-kubo-rpc-client/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/ipfs/js-kubo-rpc-client/actions/workflows/js-test-and-release.yml?query=branch%3Amain) > A client library for the Kubo RPC API @@ -11,7 +11,7 @@ - [Install](#install) - [Browser `