moodle / moodle/devdocs

[chore] Add a tool to add versions to versions.json

Open
#302 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted repo
Dominant language
TypeScript
Stars
74
Forks
652
Avg merge
2d 50m
Merged PRs (30d)
12

Description

What do we need to do?

Create a new yarn tool to add new versions to data/versions.json. Ideally this should also create the skeleton version file. The tool usage could look like:

// Add a major release version.
yarn version add-version [name] "[releaseDate]" "[generalEndDate]" "[securityEndDate]" --lts
yarn version add-version 4.1 "14 November 2022" "13 November 2023" "10 November 2025" --lts

// Add a release to the version.
yarn version add-release [name] [versionnumber] "[releasedate]" [--upgradepath="https://..."] [--minor]
yarn version add-release 4.0.2 2022041900 "11 July 2022"

// Update the date of a version.
yarn version update-date [name] [--release-date="[date]"] [--general-date="[date]"] [--security-date="[date]"]

We should create a template in src (or somewhere else..?) to use in general/releases/[majorVersion].md or general/releases/[majorVersion]/[minorVersion].md.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting data/versions.json and the existing project tooling, then locate how documentation files under general/releases are generated or maintained. Define the commands and arguments from the examples, including version and release updates, LTS dates, upgrade paths, and templates in src or another suitable location. Done means the tool updates versions.json and creates the requested version or release skeletons.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, release, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.