Skip to content

Commit

Permalink
docs: Document how to publish a release + add index to doc. (#102)
Browse files Browse the repository at this point in the history
  • Loading branch information
varungandhi-src authored Oct 6, 2022
1 parent ee42d28 commit fdda0ab
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions Development.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Developing SCIP

- [Project structure](#project-structure)
- [Code generation](#code-generation)
- [Debugging](#debugging)
- [Testing and adding new SCIP semantics](#testing-and-adding-new-scip-semantics)
- [Release a new version](#release-a-new-version)

## Project structure

- [bindings/](./bindings/): Contains a mix of generated and hand-written
Expand Down Expand Up @@ -78,3 +84,10 @@ The LSIF index can be uploaded to a local Sourcegraph instance using:
```bash
PACKAGE=MY_PACKAGE_NAME SRC_ACCESS_TOKEN=MY_TOKEN SRC_ENDPOINT=https://sourcegraph.test:3443 src code-intel upload -file="cmd/tests/snapshots/output/$PACKAGE/dump.lsif" -root="cmd/tests/snapshots/input/$PACKAGE"
```

## Release a new version

[Create a new release](https://github.com/sourcegraph/scip/releases/new)
in the web UI (or using the `gh` CLI), along with any release notes.
Once the release is created, the artifacts will be built and uploaded
automatically by the [release action](/.github/workflows/release.yml).

0 comments on commit fdda0ab

Please sign in to comment.