Skip to content

Commit fdda0ab

Browse files
docs: Document how to publish a release + add index to doc. (#102)
1 parent ee42d28 commit fdda0ab

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

Development.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Developing SCIP
22

3+
- [Project structure](#project-structure)
4+
- [Code generation](#code-generation)
5+
- [Debugging](#debugging)
6+
- [Testing and adding new SCIP semantics](#testing-and-adding-new-scip-semantics)
7+
- [Release a new version](#release-a-new-version)
8+
39
## Project structure
410

511
- [bindings/](./bindings/): Contains a mix of generated and hand-written
@@ -78,3 +84,10 @@ The LSIF index can be uploaded to a local Sourcegraph instance using:
7884
```bash
7985
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"
8086
```
87+
88+
## Release a new version
89+
90+
[Create a new release](https://github.com/sourcegraph/scip/releases/new)
91+
in the web UI (or using the `gh` CLI), along with any release notes.
92+
Once the release is created, the artifacts will be built and uploaded
93+
automatically by the [release action](/.github/workflows/release.yml).

0 commit comments

Comments
 (0)