Skip to content
This repository was 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

Merged
ojarjur merged 1 commit into
masterfrom
ojarjur/report-version-issues
Feb 14, 2018
Merged

ojarjur merged 1 commit into
masterfrom
ojarjur/report-version-issues

Conversation

@ojarjur

@ojarjur ojarjur commented Feb 13, 2018

Copy link
Copy Markdown
Contributor

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.

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.
@ojarjur
ojarjur requested a review from chmeyers February 13, 2018 23:42
Comment thread tools/cli/datalab.py

# Public file reporting all known version issues.
version_issues_url = (
'https://storage.googleapis.com/cloud-datalab/version-issues.js')

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this file already exist?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants