forked from nodejs/Release
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Schedule update guidance (nodejs#672)
* doc: add initial release guidance Fixes: nodejs#561 Co-authored-by: bl-ue <54780737+bl-ue@users.noreply.github.com>
- Loading branch information
1 parent
2bfc158
commit 4a0da08
Showing
1 changed file
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Release Guidance | ||
|
||
Guidance related to the management of Node.js releases and the release schedule. | ||
|
||
*Note: The process of creating a release is documented in the [releases.md](https://github.com/nodejs/node/blob/master/doc/guides/releases.md) file in the Node.js core repository.* | ||
|
||
# Updating the Release Schedule | ||
|
||
When making amendments to the release schedule the following files in this repository should be updated: | ||
* `schedule.json` - The JSON file should be updated to reflect the added or amended dates/entries. | ||
* `README.md` - The [Release Schedule Table](https://github.com/nodejs/Release#release-schedule) should be updated. | ||
* `schedule.svg` - The timeline graphic should be regenerated. See [Updating the schedule.svg](#updating-the-schedulesvg) | ||
|
||
# Updating the `schedule.svg` | ||
|
||
The following commands can be used to regenerate the `schedule.svg`: | ||
|
||
```sh | ||
$ npx lts --start yyyy-mm-dd --end yyyy-mm-dd -d "$PWD/schedule.json" -g "$PWD/schedule.svg" | ||
$ npx svgo "$PWD/schedule.svg" | ||
``` | ||
|
||
The start and end dates should be selected so that, at least, all currently supported versions and the next (upcoming) major version of Node.js are shown. The timeline graphic should be periodically moved forward. |