Release plan for 2018.3.0

[brettcannon]

Helpful links & info:

• Milestone

Schedule

[Note that this is a truncated release due to the elongated release cycle for 2018.2.0]

Monday, March 12

• Go through telemetry for GDPR

Planning

• Evaluate if TypeScript usage needs updating to sync with VS Code's usage
• Evaluate projects & meta issues
• Go through needs PR issues to see if there's anything we want to add to this milestone
• Finalize the initial set of issues for the milestone
• Make sure all issues for this milestone are assigned
• Close issues that have needed more info for over a month

Monday, March 19

• Go through telemetry for GDPR
• Check there have been no performance regressions

Monday, March 19

• Go through telemetry for GDPR

Get legal details started

• Announce the lock-down of dependencies for this release
• Make sure CELA has been notified of all changes to the repository and distribution dependencies

Release a beta version for testing

• Update the version to be a beta & update the changelog
• Announce the beta development build (along with how to help verify fixed issues)
• Open appropriate documentation issues

Monday, March 26

• Go through telemetry for GDPR

Prep for the release candidate

• Announce feature freeze
• Make sure the repo and distribution TPNs have been updated appropriately
• Ensure all new feature usages are tracked via telemetry
• Make sure no extraneous files are being included in the .vsix file
• Merge any last-minute pull requests

Test the release candidate code

• Update the version to be an rc & update the changelog
• Announce the release candidate development build
• Open appropriate documentation issues
• Begin drafting a blog post

Prep for releasing

• Get team agreement that the code is ready to be released
• Update the changelog (including the names of external contributors)
• Update the version number to be final
• Make sure CI is passing
• Create the release- branch
• Generate final .vsix file from the release- branch
• Make sure the appropriate pull requests for the documentation -- including the WOW page -- are ready

Start preparing for the next release

• Bump the version number to the next alpha
• Make sure the next two milestones exist
• Lift the feature freeze
• Create a new release plan

Clean up after this release

• Mark any straggling fixed issues as verified
• Close the (now) old milestone
• Delete the previous releases' branch

Wednesday, March 28 (hopefully 😉)

• Upload the final .vsix file to the marketplace
• Publish documentation changes
• Publish the blog post
• Create a release on GitHub (which creates an appropriate git tag)

[brettcannon]

This comment is to hold an initial test plan template. There is an overall template to help keep track of what environments we have tested against, and then a template for a specific environment being tested.

Testing targets

OS

• Windows 10
• macOS
• Linux

Python

Distribution

• CPython
• Anaconda (miniconda is acceptable)

Version

• 2.7
• 3.6

---

Testing plan

Environment

• OS: XXX
• Python
  • Distribution: XXX
  • Version: XXX

Tests

ALWAYS check the Output window under Python for logged errors!

Environment

Interpreters

• Interpreter is shown in the status bar
• An interpreter can be manually specified using the Select Interpreter command
• Detected system-installed interpreters
• Detected an Anaconda installation
• (Linux/macOS) Detected all interpreters installed w/ pyenv detected
• " "python.pythonPath" triggers an update in the status bar

Virtual environments

• Detected a single virtual environment at the top-level of the workspace folder
  • Appropriate suffix label specified in status bar
  • Prompt to install Pylint uses --user
  • "python.terminal.activateEnvironments": false deactivates detection
  • Create Terminal works
• Detected all conda environments created with an interpreter
  • Appropriate suffix label specified in status bar
  • Prompt to install Pylint installs into the conda environment
  • "python.terminal.activateEnvironments": false deactivates detection
  • Create Terminal works
• (Linux/macOS until -m is supported) Detected the virtual environment created by pipenv
  • Appropriate suffix label specified in status bar
  • Prompt to install Pylint uses pipenv install --dev
  • "python.terminal.activateEnvironments": false deactivates detection
  • Create Terminal works
• (Linux/macOS) Detected virtual environments created under {workspaceFolder}/.direnv/python-{python_version} for direnv and its layout python3 support
  • Appropriate suffix label specified in status bar
  • "python.terminal.activateEnvironments": false deactivates detection
  • Create Terminal works

Environment files

Sample files:

# example.py
import os
print('Hello,', os.environ.get('WHO'), '!')

# .env
WHO=world

• Environment variables in a .env file are exposed when running under the debugger
• "python.envFile" allows for specifying an environment file manually

Debugging

• pythonPath setting in your launch.json overrides your python.pythonPath/default setting

Linting

ALWAYS check under the Problems tab to see e.g. if a linter is raising errors!

Pylint/default linting

[Prompting to install Pylint is covered under Environments above]

For testing the disablement of the default linting rules for Pylint:

# pylintrc
[MESSAGES CONTROL]
enable=bad-names

# example.py
foo = 42  # Marked as a blacklisted name.

• Installation via the prompt installs Pylint as appropriate
• Pylint works
• "python.linting.pylintUseMinimalCheckers": false turns off the default rules w/ no pylintrc file present
• The existense of a pylintrc file turns off the default rules

Other linters

• flake8 works
• mypy works
• pydocstyle works
• pep8 works
• prospector works
• pylama works
• 3 or more linters work simultaneously
  • The Select Linter command lists all the above linters and prompts to install a linter when missing
  • "python.linting.enabled" disables all linters
  • The Enable Linting command changes "python.linting.enabled"
  • "python.linting.lintOnSave works

Editing

IntelliSense

• "python.autoComplete.extraPaths" works
• "python.autoComplete.preloadModules" works
• "python.autocomplete.addBrackets": true causes auto-completion of functions to append ()

Formatting

• autopep8 works
• yapf works

Refactoring

• Extract Variable works
• Extract method works
• Sort Imports works

Debugging

Unit testing