sanity-plugin-graph-view 1.0.4 → 1.0.8

package/.github/workflows/main.yml

@@ -0,0 +1,133 @@
+---
+name: CI & Release
+
+# Workflow name based on selected inputs. Fallback to default Github naming when expression evaluates to empty string
+run-name: >-
+  ${{
+    inputs.release && inputs.test && 'Build studio-v2 ➤ Test ➤ Publish to NPM' ||
+    inputs.release && !inputs.test && 'Build studio-v2 ➤ Skip Tests ➤ Publish to NPM' ||
+    github.event_name == 'workflow_dispatch' && inputs.test && 'Build studio-v2  ➤ Test' ||
+    github.event_name == 'workflow_dispatch' && !inputs.test && 'Build studio-v2  ➤ Skip Tests' ||
+    ''
+  }}
+
+on:
+  # Build on pushes branches that have a PR (including drafts)
+  pull_request:
+  # Build on commits pushed to branches without a PR if it's in the allowlist
+  push:
+    branches: [main,studio-v2]
+  # https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow
+  workflow_dispatch:
+    inputs:
+      test:
+        description: Run tests
+        required: true
+        default: true
+        type: boolean
+      release:
+        description: Release new version
+        required: true
+        default: false
+        type: boolean
+
+concurrency:
+  # On PRs builds will cancel if new pushes happen before the CI completes, as it defines `github.head_ref` and gives it the name of the branch the PR wants to merge into
+  # Otherwise `github.run_id` ensures that you can quickly merge a queue of PRs without causing tests to auto cancel on any of the commits pushed to main.
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  log-the-inputs:
+    name: Log inputs
+    runs-on: ubuntu-latest
+    steps:
+      - run: |
+          echo "Inputs: $INPUTS"
+        env:
+          INPUTS: ${{ toJSON(inputs) }}
+
+  build:
+    runs-on: ubuntu-latest
+    name: Lint & Build
+    steps:
+      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # tag=v3
+      - uses: actions/setup-node@8c91899e586c5b171469028077307d293428b516 # tag=v3
+        with:
+          cache: npm
+          node-version: lts/*
+      - run: npm ci
+        # Linting can be skipped
+      - run: npm run lint --if-present
+        if: github.event.inputs.test != 'false'
+        # But not the build script, as semantic-release will crash if this command fails so it makes sense to test it early
+      - run: npm run prepublishOnly --if-present
+
+  #  test:
+  #    needs: build
+  #    # The test matrix can be skipped, in case a new release needs to be fast-tracked and tests are already passing on main
+  #    if: github.event.inputs.test != 'false'
+  #    runs-on: ${{ matrix.os }}
+  #    name: Node.js ${{ matrix.node }} / ${{ matrix.os }}
+  #    strategy:
+  #      # A test failing on windows doesn't mean it'll fail on macos. It's useful to let all tests run to its completion to get the full picture
+  #      fail-fast: false
+  #      matrix:
+  #        # Run the testing suite on each major OS with the latest LTS release of Node.js
+  #        os: [macos-latest, ubuntu-latest, windows-latest]
+  #        node: [lts/*]
+  #        # It makes sense to also test the oldest, and latest, versions of Node.js, on ubuntu-only since it's the fastest CI runner
+  #        include:
+  #          - os: ubuntu-latest
+  #            # Test the oldest LTS release of Node that's still receiving bugfixes and security patches, versions older than that have reached End-of-Life
+  #            node: lts/-2
+  #          - os: ubuntu-latest
+  #            # Test the actively developed version that will become the latest LTS release next October
+  #            node: current
+  #    steps:
+  #      # It's only necessary to do this for windows, as mac and ubuntu are sane OS's that already use LF
+  #      - name: Set git to use LF
+  #        if: matrix.os == 'windows-latest'
+  #        run: |
+  #          git config --global core.autocrlf false
+  #          git config --global core.eol lf
+  #      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # tag=v3
+  #      - uses: actions/setup-node@8c91899e586c5b171469028077307d293428b516 # tag=v3
+  #        with:
+  #          cache: npm
+  #          node-version: ${{ matrix.node }}
+  #      - run: npm i
+  #      - run: npm test --if-present
+
+  release:
+    # needs: [build, test]
+    needs: [build]
+    # only run if opt-in during workflow_dispatch
+    if: always() && github.event.inputs.release == 'true' && needs.build.result != 'failure' && needs.test.result != 'failure' && needs.test.result != 'cancelled'
+    runs-on: ubuntu-latest
+    name: Semantic release
+    steps:
+      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # tag=v3
+        with:
+          # Need to fetch entire commit history to
+          # analyze every commit since last release
+          fetch-depth: 0
+      - uses: actions/setup-node@8c91899e586c5b171469028077307d293428b516 # tag=v3
+        with:
+          cache: npm
+          node-version: lts/*
+      - run: npm ci
+        # Branches that will release new versions are defined in .releaserc.json
+      - run: npx semantic-release
+        # Don't allow interrupting the release step if the job is cancelled, as it can lead to an inconsistent state
+        # e.g. git tags were pushed but it exited before `npm publish`
+        if: always()
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
+        # Re-run semantic release with rich logs if it failed to publish for easier debugging
+      - run: npx semantic-release --dry-run --debug
+        if: failure()
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}

package/.releaserc.json

@@ -0,0 +1,4 @@
+{
+  "extends": "@sanity/semantic-release-preset",
+  "branches": ["main", {"name": "studio-v2", "channel": "studio-v2", "range": "1.0.x"}]
+}

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+<!-- markdownlint-disable --><!-- textlint-disable -->
+
+# 📓 Changelog
+
+All notable changes to this project will be documented in this file. See
+[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [1.0.8](https://github.com/sanity-io/sanity-plugin-graph-view/compare/v1.0.7...v1.0.8) (2022-11-22)
+
+### Bug Fixes
+
+- **ci:** added semver workflow ([d179815](https://github.com/sanity-io/sanity-plugin-graph-view/commit/d179815f36bd260c8ea6d33a9e66b1e8968700b6))
+- **ci:** publish using semantic-release ([1c40d3e](https://github.com/sanity-io/sanity-plugin-graph-view/commit/1c40d3ef18928e3521eac79e725ff72737a72b2e))

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016–2020 Sanity.io
+Copyright (c) 2022–2020 Sanity.io
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -5,16 +5,35 @@
   <p><img src="assets/screengrab.gif" width="540" alt="Screengrab of the Graph tool" /></p>
 </div>
 
+> This is a Sanity Studio v2 plugin. For the v3 version, please refer to the [v3-branch](https://github.com/sanity-io/sanity-plugin-graph-view).
+
 Wonder how a visualization of your dataset will look? How many authors do you have? How many items have they worked on? And are currently working on! Edits and changes are shown in real-time!
 
 **Explore your data with this plugin, seek out strange corners and data types, boldly go where you could not before!**
 
+## Installation and use
+
+<div style="padding: 1em; border: solid 2px red;">
+**Important!** Due to an [outstanding issue with Three.js](https://github.com/sanity-io/sanity-plugin-graph-view/issues/4), you currently **have to use Yarn to install packages, not NPM, and add this to your app's `package.json`**:
+
+```json
+  "resolutions": {
+    "**/three": "0.119.1"
+  }
+```
+We hope to remedy this in the future.
+</div>
+
+
 ```sh
-# In your Sanity Studio repository:
-sanity install graph-view
+yarn add sanity-plugin-graph-view@studio-v2
+```
 
-# Start the Studio
-sanity start
+Next, add `"graph-view"` to `sanity.json` plugins array:
+```json
+"plugins": [
+  "graph-view"
+]
 ```
 
 ## Configuration
@@ -23,7 +42,7 @@ Edit `./config/graph-view.json`:
 
 ```json
 {
-  "query": "*[_type == 'a' || _type == 'b']"
+  "query": "*[_type in ['a', 'b']]"
 }
 ```
 
@@ -31,7 +50,17 @@ For references to turn into graph edges, the entire document must be fetched, bu
 
 ```json
 {
-  "query": "*[_type == 'a' || _type == 'b']{ 'refs': [author._ref, publisher._ref] }"
+  "query": "*[_type in ['a', 'b']]{ 'refs': [author, publisher] }"
+}
+```
+
+By default, the plugin uses `doc.title || doc.name || doc._id` as the node label.
+
+If you want to use another property, compute a `title` property in your query, e.g.:
+
+```json
+{
+  "query": "*[_type in ['a', 'b']] { ..., \"title\": select(_type == 'a' => 'Title A', _type == 'b' => 'Title B') }"
 }
 ```