From 0fca0a3af4463e202252a39b945e5f2431c8c416 Mon Sep 17 00:00:00 2001 From: Romain Tetley Date: Fri, 15 Sep 2023 10:15:46 +0200 Subject: [PATCH 1/2] Final steps towards release. - Bumped version nubmers to 2.0.0 - Corrected developpers doc - Updated README.md install instructions --- README.md | 12 +++-------- client/package.json | 2 +- docs/developers.md | 28 +++++++++++++++----------- flake.nix | 4 ++-- language-server/vscoqtop/lspManager.ml | 2 +- 5 files changed, 23 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 8004689c..bd0db5b6 100644 --- a/README.md +++ b/README.md @@ -40,23 +40,17 @@ 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 pin add coq 8.18 $ opam install vscoq-language-server ``` diff --git a/client/package.json b/client/package.json index 2c4ae17d..d3390351 100644 --- a/client/package.json +++ b/client/package.json @@ -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" diff --git a/docs/developers.md b/docs/developers.md index 887c71a2..c0e86770 100644 --- a/docs/developers.md +++ b/docs/developers.md @@ -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. diff --git a/flake.nix b/flake.nix index 78b65eb8..f71f277d 100644 --- a/flake.nix +++ b/flake.nix @@ -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"; @@ -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 diff --git a/language-server/vscoqtop/lspManager.ml b/language-server/vscoqtop/lspManager.ml index 54df45a2..81a2485d 100644 --- a/language-server/vscoqtop/lspManager.ml +++ b/language-server/vscoqtop/lspManager.ml @@ -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 = From b9dcbdb3ecd72d38db7b678108e2bc64ab99e80f Mon Sep 17 00:00:00 2001 From: Romain Tetley Date: Fri, 15 Sep 2023 15:27:55 +0200 Subject: [PATCH 2/2] Correcting install instructions --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index bd0db5b6..e35c2a60 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,6 @@ and (2) install and configure the VsCoq extension in either VS Code or VSCodium. After creating an opam switch, activate these repositories, pin Coq, and install the `vscoq-language-server` package: ```shell -$ opam pin add coq 8.18 $ opam install vscoq-language-server ```