Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Add Release Schedule Information #461

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions source/documentation/tools/ide-maintenance-policy/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# IDE Maintanance Policy

## Release Naming

Each release will adopt [Semantic Versioning](https://semver.org).

In GitHub, we will include detailed release notes for each tool. You can find these here:

- [JupyterLab Releases](https://github.com/ministryofjustice/analytical-platform-jupyterlab/releases)
- [Visual Studio Code Releases](https://github.com/ministryofjustice/analytical-platform-visual-studio-code/releases)
- [RStudio Releases](https://github.com/ministryofjustice/analytical-platform-rstudio/releases)
- [Cloud Development Environment Base Releases](https://github.com/ministryofjustice/analytical-platform-jupyterlab/releases)

In the Control Panel, there has historically been a loose naming convention for tooling releases. Going forward, we will adopt a clearer naming convention in the form:

`[release x.y.z] Tool Name x.y.z`

For example, for Visual Studio Code, this will appear as:

`[vscode 2.3.0] Visual Studio Code 2.3.0`

Semantic versions will match across both the GitHub repository and the Control Panel.

Release notes in GitHub will include all changes, while release communications will provide a summary.

## Release Schedule
Our Release Schedule is outlined below.

### High-Importance Security Patching
- **Timing**: As needed, outside the regular release schedule.
- **Process**: Critical security patches will be applied and released immediately upon identification.

### Release Cadence

#### Monthly Releases
- **Goal**: Ensure each software image (Visual Studio Code, JupyterLab, RStudio) is updated with the latest features, patches, and security improvements.
- **Release Date**: [Scheduled issues](https://github.com/ministryofjustice/analytical-platform/blob/087fd6064ef4c1745543e3eee18806408dae0b2a/.github/workflows/schedule-issue-cloud-development-environment-base.yml#L6) are set to maintain the images on the first of every month.

#### Release Latest Image (Version `n`)
- A new image (version `n`) is created, tested, and ready for deployment. This becomes the `latest` release.
- Version `n` is made available to customers to deploy in the Control Panel.

#### Previous Image (Version `n-1`) Remains
- The previous image (version `n-1`) remains available and supported.
- Updates for `n-1` cease, but support is still available.

#### Discontinue Older Image (Version `n-2`)
- The older image (version `n-2`) is discontinued and no longer available for download or use.

### Version Availability
- At any time, only the Latest (`n`) and Previous (`n-1`) versions are supported and available.
- Customers will be informed about the discontinuation of version `n-2` upon the release of version `n`.
- Version `n-1` and `n-2` can be any `MAJOR`, `MINOR`, or `PATCH` update as per [Semantic Versioning definitions](https://semver.org/#summary).

## Release Communications
Communications for each new release will be sent to the `#analytical-platform-support` channel. An example of this communication can be seen [here](https://mojdt.slack.com/archives/C4PF7QAJZ/p1730731994273979).
7 changes: 5 additions & 2 deletions source/documentation/tools/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Tools and services
# Tools and Services

The Analytical (AP) provides a range of tools, services and packages. This page describes the core tools and services that comprise the platform, as well as additional packages you can use to perform data analysis.
The Analytical Platform (AP) provides a range of tools, services and packages. This page describes the core tools and services that comprise the platform, as well as additional packages you can use to perform data analysis.

Note that we only provides support for third-party tools and services for features directly involving the Analytical Platform, such as bespoke configurations. For any other support with third-party tools and services, see the vendor's documentation; we have provided links where possible.

Expand Down Expand Up @@ -43,6 +43,9 @@ Development environment for writing R code and R Shiny apps. For more informatio
### [Visual Studio Code](visual-studio-code)
General purpose code editor. For more information, see the [Visual Studio Code documentation](https://code.visualstudio.com/docs).

### [Integrated Development Environment Maintenance Policy](ide-maintenance-policy)
Our [maintenance policy](ide-maintenance-policy) on the maintenance of the above tools.

## Orchestration

### [Airflow](airflow)
Expand Down
11 changes: 11 additions & 0 deletions source/tools/ide-maintenance-policy/index.html.md.erb
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: IDE Maintenance Policy
weight: 51
last_reviewed_on: 2024-11-06
review_in: 1 month
show_expiry: true
owner_slack: "#analytical-platform-support"
owner_slack_workspace: "mojdt"
---

<%= partial 'documentation/tools/ide-maintenance-policy/index' %>
Gary-H9 marked this conversation as resolved.
Show resolved Hide resolved