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.

Sign up for GitHub

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

documentation: update pre-publishing steps #9257

Merged
merged 1 commit into from
Mar 29, 2021
Merged

documentation: update pre-publishing steps #9257

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions doc/Publishing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,24 @@ It's good to give a heads-up to the Theia developers some hours before a release
Here is an [example](https://community.theia-ide.org/t/0-11-0-release/373).


## Pre-Release Steps

- Ensure that the [changelog](https://github.com/eclipse-theia/theia/blob/master/CHANGELOG.md) is updated and merged for the release.
- The `changelog` should reflect updates included in the release:
- Notable features, improvements and bug fixes.
- Any possible breaking changes.
- The `changelog` should follow the format of previous releases:
- Include the version, and date.
- Include a link to the appropriate milestone.
- Include all breaking changes in a separate section.
- Prefix entries by their most appropriate extension name (ex: `[core]`).
- Entries should include a link to their corresponding pull-request.
- Entries should be in alphabetical order.
- Entries should be in the past tense (ex: 'Added support...').
- Ensure that merged pull-requests for the given release are added to the corresponding release [milestone](https://github.com/eclipse-theia/theia/milestones):
vince-fugnitto marked this conversation as resolved.
Show resolved Hide resolved
- Generally, milestones are automatically added on merge however not for forks. It is therefore important to manually add such contributions to the milestone for the time being.


## Pre-Publishing Steps

Before publishing it's important to make sure that a functional Theia application can be made from the latest `next` version of the platform. Else we will have problems with "latest" after publishing.
Expand Down Expand Up @@ -149,5 +167,6 @@ To successfully complete a `yarn upgrade`, one must:
* Create the next two milestones in the case they do not already exist. Generally, the release is performed on the last Thursday of the month, but there may be exceptions (bug fix release, holidays, etc.)

### Update Roadmap

* If the current release is the last in a quarter, ask the team to update the [roadmap](https://github.com/eclipse-theia/theia/wiki/Roadmap) of the past quarter (close, remove or move items)
* If the current release is the second in a quarter, create [roadmap template](https://github.com/eclipse-theia/theia/wiki/Roadmap) for the next quarter, ask the team to contribute to it and add it to the agenda of the Theia dev meeting