CONTRIBUTING.md

Contributing

This plugin is developed in the bobheadxi/raycast-sourcegraph repository, not in the raycast/extensions repository where releases are published.

Clone the Sourcegraph for Raycast repository and use the "Import Extension" command in Raycast to point to your clone of this repository. In this repository, then run:

npm install
npm run dev

The "Search Sourcegraph" command should now be available within Raycast.

Code style

Prettier is used for code style, and a formatting command is available:

npm run fmt

Checks can be run with:

npm run lint

Changelog style

See the Raycast version history guide.

Screenshots

Screenshots for the Raycast store are in the metadata/ directory. See the Raycast extension screenshots guide.

The current screenshot samples are:

1. Search context:cncf store (type:file OR type:symbol)
2. Search r:^github\.com/etcd\-io/etcd$ f:etcdutl/etcdutl/snapshot_command\.go type:symbol store -> select first result
3. Notebooks actor propagation -> preview
4. Batch Changes -> find random batch change with mix of merged and unmerged changesets

Publishing to the Raycast store

The latest release of this extension is published to extensions/sourcegraph in raycast/extensions.

To make a release, set up a clone of the Raycast extensions repository and create a new branch:

export RAYCAST_EXTENSIONS_DIR="../../raycast/extensions"
mkdir -p $RAYCAST_EXTENSIONS_DIR
cd $RAYCAST_EXTENSIONS_DIR

git clone --no-checkout --filter=blob:none $FORK .
git sparse-checkout init --cone
git sparse-checkout set extensions/sourcegraph
git checkout main

cd - # back to raycast-sourcegraph

Then, in your clone of the raycast-sourcegraph repository:

# check that a build works successfully
npm run build
# copy repo into publish directory
npm run raycast-publish

Then open a pull request upstream and follow the steps in the pull request template.