diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 42f87bb..a2756cf 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -9,8 +9,8 @@ jobs: - uses: actions/checkout@v2 - uses: actions/setup-node@v2 with: - node-version: '16.x' - registry-url: 'https://registry.npmjs.org' + node-version: "16.x" + registry-url: "https://registry.npmjs.org" - run: cp README.md packages/react-arborist/README.md - run: yarn - run: yarn workspace react-arborist build diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..124d1e0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# Testing Locally + +1. Clone the repo +2. From the root, run yarn start + +# Publishing a Release + +### Release Branch + +1. Checkout main locally +2. Increment the version number in packages/react-arborist/package.json +3. Create a branch called release/v0.0.0 +4. Open a PR to main +5. Test, review, and merge + +### Create Github Release + +1. Create a release based on main +2. Assign a new tag to be created with v0.0.0 +3. Write release notes +4. Publish + +The Github actions workflow will publish to npm. diff --git a/README.md b/README.md index aacdf58..bf85d80 100644 --- a/README.md +++ b/README.md @@ -718,6 +718,4 @@ Returns the root _NodeApi_ instance. Its children are the Node representations o ## Author -This library was created by James Kerr while working at Brim Data on the [Zui desktop app](https://www.youtube.com/watch?v=I2y663n8d2A). Work with data? Check us out at [brimdata.io](https://www.brimdata.io) - -[Follow me on Twitter](https://twitter.com/specialCaseDev) for react-arborist updates. +[James Kerr](https://twitter.com/specialCaseDev) at [Brim Data](https://brimdata.io) for the [Zui desktop app](https://www.youtube.com/watch?v=I2y663n8d2A). diff --git a/packages/react-arborist/package.json b/packages/react-arborist/package.json index 914571e..e9701bf 100644 --- a/packages/react-arborist/package.json +++ b/packages/react-arborist/package.json @@ -1,13 +1,14 @@ { "name": "react-arborist", - "version": "2.1.1", + "version": "2.2.0", "license": "MIT", "source": "src/index.ts", "main": "dist/index.js", "module": "dist/module.js", "types": "dist/index.d.ts", - "repository": "https://github.com/brimdata/react-arborist", + "repository": "github:brimdata/react-arborist", "homepage": "https://react-arborist.netlify.app", + "bugs": "https://github.com/brimdata/react-arborist/issues", "keywords": [ "react", "arborist",