Skip to content

Commit

Permalink
README.md: generate the version for nightly during release
Browse files Browse the repository at this point in the history
And change back to the version from upstream.
That will ease the sync process and less confusing during migration.

Change-Id: I6b3a7e2157bdc586f9f5052ec1db46a86bbaed01
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/232459
Reviewed-by: Rebecca Stambler <[email protected]>
  • Loading branch information
hyangah committed May 12, 2020
1 parent 110d5e1 commit 14161b8
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 28 deletions.
1 change: 1 addition & 0 deletions .vscodeignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ test/
**/tslint.json
build/**/*
docs/
*.md.nightly
34 changes: 7 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,10 @@
# Go Nightly for VS Code

> ### **ATTENTION**
>**Go Nightly for VS Code** is the insider version of
[VS Code Go extension](https://github.com/microsoft/vscode-go)
for early feedback and testing. This extension works best with
[VS Code Insiders](https://code.visualstudio.com/insiders).
Go Nightly contains previews of new features and bug fixes that are still
under review or testing, so can be unstable. If you are looking for the stable version,
please use [the stable version](https://marketplace.visualstudio.com/items?itemName=ms-vscode.go) instead.
>
> **NOTE:**
If you have both stable (aka "Go") and nightly version (aka "Go Nightly") installed,
you MUST DISABLE one of them. Docs on how to disable an extension can be found
[here](https://code.visualstudio.com/docs/editor/extension-gallery#_disable-an-extension).

> ### Difference between VS Code Go and VS Code Go Nightly
> - Go Nightly is maintained and released by Go Tools team at Google.
> - Go Nightly is released more frequently than the stable version.
> - Go Nightly includes features and bug fixes that are still under testing or not finalized yet.
> - Go Nightly may use the latest pre-release versions of tools (e.g. `gopls`) instead of release versions.
> - For now, Go and Go Nightly maintain separate repositories. Both repositories
> welcome all contributors. For contribution to Go Nightly repo, see the Go
> project's [contribution guide](https://golang.org/doc/contribute.html).
> Go team members who has signed the Microsoft CLA will send a syncing PR upstream to
> https://github.com/microsoft/vscode-go every two weeks.
> - [Here](https://github.com/microsoft/vscode-go/compare/master...golang:master) is the full list of local modifications.
# Go for Visual Studio Code

[![Join the chat at https://gitter.im/Microsoft/vscode-go](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Microsoft/vscode-go?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://travis-ci.org/Microsoft/vscode-go.svg?branch=master)](https://travis-ci.org/Microsoft/vscode-go)

This extension adds rich language support for the [Go language](https://golang.org/) to VS Code.

Read the [Changelog](https://github.com/Microsoft/vscode-go/blob/master/CHANGELOG.md) to know what has changed over the last few versions of this extension.

## Table of Contents

Expand Down
27 changes: 27 additions & 0 deletions README.md.nightly
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Go Nightly for VS Code

> ### **ATTENTION**
>**Go Nightly for VS Code** is the insider version of
[VS Code Go extension](https://github.com/microsoft/vscode-go)
for early feedback and testing. This extension works best with
[VS Code Insiders](https://code.visualstudio.com/insiders).
Go Nightly contains previews of new features and bug fixes that are still
under review or testing, so can be unstable. If you are looking for the stable version,
please use [the stable version](https://marketplace.visualstudio.com/items?itemName=ms-vscode.go) instead.
>
> **NOTE:**
If you have both stable (aka "Go") and nightly version (aka "Go Nightly") installed,
you MUST DISABLE one of them. Docs on how to disable an extension can be found
[here](https://code.visualstudio.com/docs/editor/extension-gallery#_disable-an-extension).

> ### Difference between VS Code Go and VS Code Go Nightly
> - Go Nightly is maintained and released by Go Tools team at Google.
> - Go Nightly is released more frequently than the stable version.
> - Go Nightly includes features and bug fixes that are still under testing or not finalized yet.
> - Go Nightly may use the latest pre-release versions of tools (e.g. `gopls`) instead of release versions.
> - For now, Go and Go Nightly maintain separate repositories. Both repositories
> welcome all contributors. For contribution to Go Nightly repo, see the Go
> project's [contribution guide](https://golang.org/doc/contribute.html).
> Go team members who has signed the Microsoft CLA will send a syncing PR upstream to
> https://github.com/microsoft/vscode-go every two weeks.
> - [Here](https://github.com/microsoft/vscode-go/compare/master...golang:master) is the full list of local modifications.
3 changes: 2 additions & 1 deletion build/all.bash
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,9 @@ prepare_nightly() {
') > /tmp/package.json && mv /tmp/package.json package.json

# Replace CHANGELOG.md with CHANGELOG.md.nightly + Release commit info.
# TODO(hyangah): Update README.md
printf "**Release ${VER} @ ${COMMIT}** \n\n" | cat - CHANGELOG.md.nightly > /tmp/CHANGELOG.md.new && mv /tmp/CHANGELOG.md.new CHANGELOG.md
# Replace the heading of README.md with the heading for Go Nightly.
sed '/^# Go for Visual Studio Code$/d' README.md | cat README.md.nightly - > /tmp/README.md.new && mv /tmp/README.md.new README.md
}

main() {
Expand Down

0 comments on commit 14161b8

Please sign in to comment.