Release checklist

[mattseddon]

Things that need to happen before we make a public release announcement

• Error handling and debugging - Story: Investigate and implement debugging best practices #470
• Update Details section, changelog, get started - Update extensions Details section #434, Create the Get Started page #435
• Document that we collect telemetry information and users can opt-out by setting telemetry.enableTelemetry to false (Story: Product analytics #511 (comment)).
• Ask VS Code to prompt the user to install our extension when "dvc.yaml" or "dvc.lock" or ".dvc" file is present
• Investigate walkthroughs
• Add plots into walkthrough
• Check everything in walkthrough is up to date and correct (Review and update the walkthrough #1876)
• Make repo public
• Remove preview tag from extension (Remove preview tag from marketplace listing #1860)
• README = marketplace listing -> the existing one needs to be reworked (README rewrite (+ CONTRIB updates) #1816)
• Add extra badges once the repo is public (https://shields.io/) (Add badges to README #1873)
• Add repo banner (Preview banner #1875)
• Make sure VS Code is added to DVC README (readme: mention vs code extension dvc#7859)
• Add to iterative README (https://github.com/iterative)
• Verify Iterative as a publisher
• Release pipeline (Document/automate extension packaging/publishing process #754)
• Publish to Open VSX from the pipeline Prepare and publish on open VSX #1595
• Internal alpha testing
• Early adopter testing
• Minification of code / Tree shaking (optional) - won't do
• Implement light theme design (light svgs Placeholder: Needs design #175 (comment)) - won't do
• Consider extension pack (Yaml parser, vscode-cml and whatever the dvc-azure plugin is called) - consider later
• Revisit Restricted Mode with a walkthrough explanation and/or allowing limited capability
• Rename master to main
• Automate changelogs
• Create marketplace release checklist - won't do, after release has been further automate we can release more often instead
• Check dependency licenses
• Test against arbitrary large repo (Release checklist #429 (comment)) - done for now

Won't do

• Rework of data management code after dvc status is released
• E2E tests

[mattseddon]

This action will be handy for the release pipeline: https://github.com/HaaLeo/publish-vscode-extension

We can also get more badges from https://shields.io/ once the repo is public.

[shcheklein]

One more thing to do is to check it on the repo with a lot of columns / data files. See that we are not breaking and can handle (cut the scope) so that the extension doesn't kill the whole system.

We could use https://github.com/iterative/dvcgen for this.

[mattseddon]

See this slack thread for discussion on large repo performance

[mattseddon]

Current list of Licenses:

❯ npx license-checker --summary 
npx: installed 58 in 1.577s
├─ MIT: 1554
├─ ISC: 137
├─ BSD-3-Clause: 102
├─ BSD-2-Clause: 41
├─ Apache-2.0: 36
├─ (MIT OR CC0-1.0): 4
├─ CC0-1.0: 3
├─ MPL-2.0: 3
├─ Unlicense: 3
├─ MIT*: 3
├─ CC-BY-4.0: 2
├─ WTFPL: 2
├─ 0BSD: 2
├─ (Unlicense OR Apache-2.0): 1
├─ Python-2.0: 1
├─ (MIT OR Apache-2.0): 1
├─ Custom: http://github.com/substack/node-bufferlist: 1
├─ UNLICENSED: 1
├─ LGPL-3.0: 1
├─ (MIT OR WTFPL): 1
├─ BSD*: 1
├─ (Apache-2.0 OR MPL-1.1): 1
├─ ODC-By-1.0: 1
├─ (BSD-3-Clause OR GPL-2.0): 1
├─ (MIT AND Zlib): 1
├─ (WTFPL OR MIT): 1
├─ (BSD-2-Clause OR MIT OR Apache-2.0): 1
├─ (MIT AND BSD-3-Clause): 1
├─ (BSD-2-Clause OR WTFPL): 1
├─ CC-BY-3.0: 1
└─ (MIT OR GPL-3.0): 1

http://github.com/substack/node-bufferlist - MIT

👍🏻 good to go.

[mattseddon]

Check everything in walkthrough is up to date and correct
&
README = marketplace listing -> the existing one needs to be reworked

both dependent on #1603

[mattseddon]

Related to publishing to Open VSX - EclipseFdn/open-vsx.org#1024