Skip to content

Latest commit

 

History

History
62 lines (50 loc) · 5.44 KB

roadmap-issue.md

File metadata and controls

62 lines (50 loc) · 5.44 KB
Raw

The purpose of this roadmap is to let anyone know about the different steps in the future Meilisearch release: <<version>>.

Draft phase (weeks 1-4)

Starts: 20XX-XX-XX Ends: 20XX-XX-XX

  • EM creates a new Milestone. This roadmap issue is automatically created.
  • EM pins this roadmap issue to the repository.
  • EM adds the release dates to this roadmap issue in the different sections.
  • EM add this roadmap issue link to the Milestone description.
  • Planification of the next release content (features, improvements, bug fixes). Meeting with the whole engine team to discuss and agree on what we are going to put in the next release.
  • Creation of PRDs.
  • Engine team opens issues to add them to the Milestone and pinged the related teams on it. Issues related to bugs could also be added to the Milestone.
  • EM updates the delivery table of the team (internal link) based on the just created issues. The goal is to clarify the priority of the sprint.
  • At the end of the Draft phase, the PM and the engine manager review together and agree on a firm version of the next release plan. The PM provides the firm version of the PRDs, which means the developers have enough information to begin the implementation phase.

Implementation phase (weeks 5-8)

Starts: 20XX-XX-XX Ends: 20XX-XX-XX

  • EM creates notes about the current implemented release to detail each planned issue (the usage, the PRD, the Slack channel, the risks...) and shares them to #ms-release.
  • Engine team implements the planned content of the release according to the PRD. The code changes are merged into the main branch. If needed, prototypes will be shared with the users. According to their feedback, we might apply changes to the related feature.
  • EM checks with the mini-dashboard maintainer if a new version of the mini-dashboard has been released and if we want to integrate it.
  • Usage of each feature should be provided in the related PRD (if no PRD, in the GitHub issue) by the end of the sprint.
  • EM writes the changelog for the release.
  • Review of the changelogs by engine team developers (for the technical information), & PM (for the feature promotion).
  • At the end of the phase, if features are missing or are not ready to be integrated into the release, EM should inform the other teams on #ms-releases (internal Slack). The not-ready issues for the sprint should be removed from the Milestone.

Pre-release phase (weeks 9-12)

Starts: 20XX-XX-XX Ends: 20XX-XX-XX

  • Engine team releases the first RC (release candidate) using the prepared changelogs.
  • EM creates notes about the just implemented release to detail each solved issue (the usage, the PRD, the Slack channel, the results...) and shares them to #ms-release.
  • Integration and docs organize their preparation for the release.
  • At the beginning of the Pre-release Phase, the PM on Product discussions about the RC to encourage people to test them. If needed, they also sync with DevRel team for some communication on Discord for the community.
  • SDKs are updated according to the new Meilisearch release.
  • Docs team updates the documentation to reflect the changes of the new Meilisearch release.
  • According to feedback and bug reports, the engine team modifies the code and fixes bugs as soon as possible. Other RCs are released if necessary.
  • Docs team reviews the final changelogs.
  • DevRel team writes a blog post “What’s new in <>?”.
  • Review the blog post.
  • Engine team updates the Open API file. The PR must be reviewed by the PM.
  • Engine manager updates the Table of Truth (internal link) with PRDs, product discussions (for experimental features) and issues (if changed are applied and not related to any PRDs)
  • Engine team ensures the feature usages described in PRDs are up-to-date with the latest changes made during pre-release.
  • Engine team creates/updates a product discussion for the experimental features released during the sprint.

Release phase (week 13)

Release date: 20XX-XX-XX

  • Engine team releases the official version and lets the other teams know when the binary and the Docker images are available on #ms-releases (internal Slack). The following teams must be pinged: documentation, integration, devrel, and cloud to ensure the deployment of their activities on their side.
  • Engine team brings changes from release-vX.Y.Z branch of Meilisearch into the main branch.
  • PM closes every part relating to the release in the product repository
  • Unpin this current roadmap issue.
  • EM merges the changelogs PR.
  • EM ensures all the issues in the Milestone are closed or removed from the Milestone (including this issue when everything is done).
  • EM closes the release Milestone.