Skip to content

Commit

Permalink
Merge pull request #621 from coq-community/release-version-bump
Browse files Browse the repository at this point in the history
Final steps towards release.
  • Loading branch information
rtetley authored Sep 15, 2023
2 parents 110dec5 + b9dcbdb commit da59960
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 25 deletions.
11 changes: 2 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,23 +40,16 @@ and contributors.
compatible with Coq 8.18 or more recent, and supports manual or continuous mode
checking.

## Installing a VsCoq 2 beta release
## Installing VsCoq 2

To use a beta release of VsCoq 2, you need to (1) install the VsCoq 2 language server
To use VsCoq 2, you need to (1) install the VsCoq 2 language server
and (2) install and configure the VsCoq extension in either VS Code or VSCodium.

### Installing the language server

The beta releases of the language server are available in the
`extra-dev` [Coq opam repository](https://github.com/coq/opam#usage),
and relies on Coq 8.18+rc1 from the `core-dev` Coq opam repository.

After creating an opam switch, activate these repositories, pin Coq,
and install the `vscoq-language-server` package:
```shell
$ opam repo add coq-core-dev https://coq.inria.fr/opam/core-dev
$ opam repo add coq-extra-dev https://coq.inria.fr/opam/extra-dev
$ opam pin add coq 8.18+rc1
$ opam install vscoq-language-server
```

Expand Down
2 changes: 1 addition & 1 deletion client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "VsCoq is an extension for Visual Studio Code with support for the Coq Proof Assistant",
"publisher": "maximedenes",
"license": "MIT",
"version": "1.9.3",
"version": "2.0.0",
"repository": {
"type": "git",
"url": "https://github.com/coq-community/vscoq.git"
Expand Down
28 changes: 16 additions & 12 deletions docs/developers.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,19 +96,23 @@ the language-server folder nor in PATH), set `VSCOQPATH` to the binary you
want to be run by the test.

# Release process

To release a new version of VsCoq:
1. First make sure to bump the version number in the three folowing files:
- flake.nix
- client/package.json
- language-server/vscoqtop/lspManager.ml
2. Create a signed tag for the release with the new version number
```shell
git tag -s #VERSION_NUMBER
```
3. Push
```shell
git push origin #VERSION_NUMBER
```

1. First make sure to bump the version number in the three folowing files:
- flake.nix
- client/package.json
- language-server/vscoqtop/lspManager.ml

2. Create a signed tag for the release with the new version number
```shell
git tag -s #VERSION_NUMBER
```
3. Push
```shell
git push origin #VERSION_NUMBER
```

Version semantics are currently as follows: v#NUMBER+coq#COQ_VERSION (ex: v1.9.2+coq.8.18)

Once the CI has run, a draft release will be automatically created. Open the draft release and edit the change log to your liking.
Expand Down
4 changes: 2 additions & 2 deletions flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
type = "github";
owner = "coq";
repo = "coq";
ref = "V8.18+rc1";
ref = "V8.18.0";
};

coq-8_18.inputs.nixpkgs.follows = "nixpkgs";
Expand All @@ -31,7 +31,7 @@
ocamlPackages.buildDunePackage {
duneVersion = "3";
pname = "vscoq-language-server";
version = "1.9.3";
version = "2.0.0";
src = ./language-server;
buildInputs = [
coq
Expand Down
2 changes: 1 addition & 1 deletion language-server/vscoqtop/lspManager.ml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ let conf_request_id = 3456736879

let server_info = InitializeResult.create_serverInfo
~name:"vscoq-language-server"
~version:"1.9.3"
~version:"2.0.0"
()

type lsp_event =
Expand Down

0 comments on commit da59960

Please sign in to comment.