Skip to content

Release Process

gnikit edited this page Oct 26, 2022 · 1 revision

Creating Modern Fortran for VS Code Release

This document outlines the steps to be followed when creating a new Release for the Visual Studio Code extension. Only members of the @vscode-team should issue releases!

Release Workflow

Releases and tags follow SemVer syntax e.g. v3.5.0.

  • Always prefix the version number with v when making a tag.
  • Always use a patch number of 0 for a manual release. All other patch numbers are used by the Nightly build.
  1. Ensure that all GitHub Action workflows are passing in the main branch
  2. Create a Wiki page on this repo with:
    • A Table Of Contents Markdown All in One (yzhang.markdown-all-in-one) VS Code extension can auto generate this. The main fields should be:
      • ## Linter
      • ## Language Server
      • ## User Interface (UI)
      • ## Syntax Highlighting
      • ## Other Changes
    • Descriptions, images and/or animations showing the new features added from the User's perspective
    • If new Settings i.e settings.json have been added outline them under ### New Settings in their respective section
    • If new Commands i.e. command palette actions, have been added outline them under ### New Commands in their respective section
    • Standalone Bug Fixes that do not fit in any other category or are minor place under ## πŸ› Bug Fixes πŸ›
  3. Update the URL link in src/extension.ts for the new Wiki page
  4. Update package.json version to the new version and wait for the GitHub Action workflows to all pass
  5. You can now issue a Release from GitHub. Remember to prefix the tag with v, e.g. v3.5.0

Post Release Actions

Announce the Release on Discourse

Modern Fortran for VS Code releases should be announced in the Fortran-lang Discourse along with a copy of the Release Notes Wiki with the Changes.


Template for Release Notes

# What's New <!-- omit in toc -->

## πŸŽ‰ Modern Fortran Release vX.Y.0 πŸŽ‰! <!-- omit in toc -->

- [Linter](#linter)
- [Language Server](#language-server)
- [User Interface (UI)](#user-interface-ui)
- [Syntax Highlighting](#syntax-highlighting)
- [Other Changes](#other-changes)
- [πŸ› Bug Fixes πŸ›](#-bug-fixes-)

## Linter

## Language Server

## User Interface (UI)

## Syntax Highlighting

## Other Changes

## πŸ› Bug Fixes πŸ›