Skip to content

Commit c233889

Browse files
committed
all: remove reference to the nightly extension
The nightly is deprecated in favor of the new pre-release versions. Clean up docs and references. Use "Pre-release" instead of "Preview" in user-facing doc. (We also use "insiders" or "preview" to refer to VS Code Pre-release inside our code or project to distinguish from semver's prerelease, but outside our project, "Pre-release extension" is the term to use) For #1953 Change-Id: Id9e5cc53fb1f459e69e7aa264ef76799b069c676 Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/613178 kokoro-CI: kokoro <[email protected]> Reviewed-by: Robert Findley <[email protected]> Commit-Queue: Hyang-Ah Hana Kim <[email protected]>
1 parent 1c7cd8f commit c233889

11 files changed

+21
-198
lines changed

README.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -125,11 +125,19 @@ modules or uncommon project layouts, you will need to configure your workspace
125125
by using [Workspace Folders]. See the
126126
[Supported workspace layouts documentation] for more information.
127127

128-
## Preview version
128+
## Pre-release version
129129

130130
If you'd like to get early access to new features and bug fixes, you can use the
131-
nightly build of this extension. Learn how to install it in by reading the
132-
[Go Nightly documentation](https://github.com/golang/vscode-go/wiki/nightly).
131+
pre-release extension. Following the vscode's [convention](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#prerelease-extensions),
132+
we use the minor version of the extension version number to distinguish stable
133+
and pre-release versions (`0.ODD_NUMBER.patch` for pre-release, `0.EVEN_NUMBER.patch`
134+
for stable release).
135+
136+
To install the pre-release version, use the drop-down list
137+
to select "Install Pre-Release Version", or if already installed the Go extension,
138+
use the "Switch to Pre-Release Version" option in the Visual Studio Code
139+
extension management page. For more details about this mechanism, see the
140+
[Visual Studio Code's documentation](https://code.visualstudio.com/updates/v1_63#_pre-release-extensions).
133141

134142
## Telemetry
135143

build/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
### Release process
22

3-
The golang.go-nightly extension is released daily during weekdays, based on the latest commit to the master branch.
3+
> 🚧 Under construction 🚧
44
5-
(Note: the release process is currently in GH workflow. We are in process of moving it to a GCB workflow.)
5+
We are currently working on migrating the release process to the Go project's relui (golang.org/x/build/cmd/relui).
66

77
* Dockerfile: defines the image containing tools and environments needed to build and test the extension. (e.g. Go, Node.js, jq, etc.)
88
* build-ci-image.yaml: defines the workflow to build the container image used for extension testing and releasing.
9-
* release-nightly.yaml: defines the workflow that builds the nightly extension and runs tests. The built extension is pushed only after all tests pass.
9+
* release.yaml: defines the (soon-to-be-deprecated) workflow to build/publish the extension in GCB.

build/all.bash

+2-35
Original file line numberDiff line numberDiff line change
@@ -77,32 +77,6 @@ run_test_in_docker() {
7777
docker run --cap-add SYS_PTRACE --shm-size=8G --workdir=/workspace -v "$(pwd):/workspace" vscode-test-env ci
7878
}
7979

80-
prepare_nightly() {
81-
# Version format: YYYY.MM.DDHH based on the latest commit timestamp.
82-
# e.g. 2020.1.510 is the version built based on a commit that was made
83-
# on 2020/01/05 10:00
84-
local VER=`git log -1 --format=%cd --date="format:%Y.%-m.%-d%H"`
85-
local COMMIT=`git log -1 --format=%H`
86-
echo "**** Preparing nightly release : ${VER} (${COMMIT}) ***"
87-
# Update package.json
88-
(cat extension/package.json | jq --arg VER "${VER}" '
89-
.version=$VER |
90-
.preview=true |
91-
.name="go-nightly" |
92-
.displayName="Go Nightly" |
93-
.publisher="golang" |
94-
.description="Rich Go language support for Visual Studio Code (Nightly)" |
95-
.contributes.configuration.properties."go.delveConfig".properties.hideSystemGoroutines.default=true
96-
') > /tmp/package.json && cp /tmp/package.json extension/package.json
97-
98-
# Replace CHANGELOG.md with CHANGELOG.md + Release commit info.
99-
printf "**Release ${VER} @ ${COMMIT}** \n\n" | cat - extension/CHANGELOG.md > /tmp/CHANGELOG.md.new && mv /tmp/CHANGELOG.md.new extension/CHANGELOG.md
100-
# Replace the heading of README.md with the heading for Go Nightly.
101-
sed '/^# Go for Visual Studio Code$/d' README.md | cat build/nightly/README.md - > /tmp/README.md.new && mv /tmp/README.md.new README.md
102-
# Replace src/const.ts with build/nightly/const.ts.
103-
cp build/nightly/const.ts extension/src/const.ts
104-
}
105-
10680
main() {
10781
cd "$(root_dir)" # always start to run from the extension source root.
10882
case "$1" in
@@ -120,17 +94,10 @@ main() {
12094
"ci")
12195
go_binaries_info
12296
setup_virtual_display
123-
run_doc_test
97+
run_doc_test
12498
run_test
125-
run_lint
126-
;;
127-
"prepare_nightly")
128-
prepare_nightly
99+
run_lint
129100
;;
130-
"test_nightly")
131-
setup_virtual_display
132-
run_test
133-
;;
134101
*)
135102
usage
136103
exit 2

build/nightly/README.md

-14
This file was deleted.

build/nightly/const.ts

-9
This file was deleted.

build/release-nightly.yaml

-84
This file was deleted.

docs/contributing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
We welcome your contributions and thank you for working to improve the Go development experience in VS Code.
44

5-
This guide will explain the process of setting up your development environment to work on the VS Code Go extension, as well as the process of sending out your change for review. If you're interested in testing the master branch or pre-releases of the extension, please see the [Go Nightly documentation](nightly.md).
5+
This guide will explain the process of setting up your development environment to work on the VS Code Go extension, as well as the process of sending out your change for review.
66

77
Our canonical Git repository is located at https://go.googlesource.com/vscode-go and https://github.com/golang/vscode-go is a mirror.
88

docs/debugging.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ adapter in favor of direct communication with Delve via
1919
📣 **We are happy to announce that the new _`dlv-dap`_ mode of Delve
2020
integration is enabled for _local_ _debugging_ by default. For
2121
[_remote_ _debugging_](#remote-debugging) it is the default in
22-
[Go Nightly](nightly.md) and is available with stable builds on demand with
22+
[pre-release versions](https://github.com/golang/vscode-go/blob/master/README.md#pre-release-version) and is available with stable builds on demand with
2323
`"debugAdapter": "dlv-dap"` attribute in `launch.json` or `settings.json`!**
2424

2525
Many features and settings described in this document may be available only with

docs/nightly.md

-43
This file was deleted.

extension/src/config.ts

+1-3
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,8 @@ export class ExtensionInfo {
4646
this.version = version?.format();
4747
this.appName = vscode.env.appName;
4848

49-
// golang.go-nightly: packageJSON.preview is true.
5049
// golang.go prerelease: minor version is an odd number.
51-
this.isPreview =
52-
!!packageJSON?.preview || !!(extensionId === 'golang.go' && version && version.minor % 2 === 1);
50+
this.isPreview = !!(extensionId === 'golang.go' && version && version.minor % 2 === 1);
5351
this.isInCloudIDE =
5452
process.env.CLOUD_SHELL === 'true' ||
5553
process.env.MONOSPACE_ENV === 'true' ||

extension/src/goInstallTools.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -902,8 +902,8 @@ export async function maybeInstallVSCGO(
902902
extensionPath: string,
903903
isPreview: boolean
904904
): Promise<string> {
905-
// golang.go stable, golang.go-nightly stable -> install once per version.
906-
// golang.go dev through launch.json -> install every time.
905+
// golang.go stable stable -> install once per version.
906+
// golang.go pre-release/dev through launch.json -> install every time.
907907
const progPath = path.join(extensionPath, 'bin', correctBinname('vscgo'));
908908

909909
if (extensionMode === vscode.ExtensionMode.Production && executableFileExists(progPath)) {

0 commit comments

Comments
 (0)