From 95355f13c534ad3775415c859d8d6cfc3f8adcc7 Mon Sep 17 00:00:00 2001 From: Gary H <26419401+Gary-H9@users.noreply.github.com> Date: Wed, 6 Nov 2024 14:37:48 +0000 Subject: [PATCH 1/2] :memo: Add Release Schedule Information --- .../tools/ide-maintenance-policy/index.md | 56 +++++++++++++++++++ source/documentation/tools/index.md | 7 ++- .../ide-maintenance-policy/index.html.md.erb | 11 ++++ 3 files changed, 72 insertions(+), 2 deletions(-) create mode 100644 source/documentation/tools/ide-maintenance-policy/index.md create mode 100644 source/tools/ide-maintenance-policy/index.html.md.erb diff --git a/source/documentation/tools/ide-maintenance-policy/index.md b/source/documentation/tools/ide-maintenance-policy/index.md new file mode 100644 index 00000000..84f029f5 --- /dev/null +++ b/source/documentation/tools/ide-maintenance-policy/index.md @@ -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). diff --git a/source/documentation/tools/index.md b/source/documentation/tools/index.md index 146e8547..6ffd9d49 100644 --- a/source/documentation/tools/index.md +++ b/source/documentation/tools/index.md @@ -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. @@ -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) diff --git a/source/tools/ide-maintenance-policy/index.html.md.erb b/source/tools/ide-maintenance-policy/index.html.md.erb new file mode 100644 index 00000000..f06c98dd --- /dev/null +++ b/source/tools/ide-maintenance-policy/index.html.md.erb @@ -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' %> \ No newline at end of file From d642d41b64799fc104ac8d9500719d513cc9647e Mon Sep 17 00:00:00 2001 From: Gary <26419401+Gary-H9@users.noreply.github.com> Date: Thu, 14 Nov 2024 12:24:53 +0000 Subject: [PATCH 2/2] Update source/tools/ide-maintenance-policy/index.html.md.erb Co-authored-by: julialawrence <98329494+julialawrence@users.noreply.github.com> --- source/tools/ide-maintenance-policy/index.html.md.erb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/tools/ide-maintenance-policy/index.html.md.erb b/source/tools/ide-maintenance-policy/index.html.md.erb index f06c98dd..e8b10181 100644 --- a/source/tools/ide-maintenance-policy/index.html.md.erb +++ b/source/tools/ide-maintenance-policy/index.html.md.erb @@ -8,4 +8,4 @@ owner_slack: "#analytical-platform-support" owner_slack_workspace: "mojdt" --- -<%= partial 'documentation/tools/ide-maintenance-policy/index' %> \ No newline at end of file +<%= partial 'documentation/tools/ide-maintenance-policy/index' %>