This repository has been archived by the owner on Sep 3, 2022. It is now read-only.
Add a facility to warn users of versions with known issues. #1958
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change was prompted by the recent issue we had with version 20180105, where an issue was discovered, but we did not have a good means of notifying users about the issue. With this change, the CLI will download a versions info file from https://storage.googleapis.com/cloud-datalab/version-issues.js that contains a JSON object reporting known issues for any affected versions of the CLI. It will then check the current version against that object and report any matching warnings.
chmeyers
approved these changes
Feb 13, 2018
| @@ -113,6 +114,11 @@ | |||
| datalab_component = 'datalab' | |||
|
|
|||
|
|
|||
| # Public file reporting all known version issues. | |||
| version_issues_url = ( | |||
| 'https://storage.googleapis.com/cloud-datalab/version-issues.js') | |||
There was a problem hiding this comment.
Does this file already exist?
There was a problem hiding this comment.
Yes, it does. I populated it with information about the 20180105 release so that I could verify the warnings appear correctly.
For example, if you run gcloud components update --version 185.0.0, and then run the version of this code from this branch, you will get the following result:
$ ./tools/cli/datalab.py list
You are using the Datalab CLI version "20180105", which has the following known issues:
Instances fail to mount their notebooks disk on first boot. The root cause is a race condition first reported here: https://github.com/googledatalab/datalab/issues/1898. The issue is fixed in versions 20180119 and later. As a workaround, failing instances will correcly mount their notebooks disk after being reset.
Listed 0 items.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change was prompted by the recent issue we had with version
20180105, where an issue was discovered, but we did not have a
good means of notifying users about the issue.
With this change, the CLI will download a versions info file from
https://storage.googleapis.com/cloud-datalab/version-issues.js
that contains a JSON object reporting known issues for any
affected versions of the CLI. It will then check the current
version against that object and report any matching warnings.