From 8d826e478f970dabac0d8dc3f6895a3fd0213ee2 Mon Sep 17 00:00:00 2001 From: curquiza Date: Thu, 6 Apr 2023 17:10:00 +0200 Subject: [PATCH] Update the prototype section in CONTRIBUTING.md --- CONTRIBUTING.md | 26 +++----------------------- 1 file changed, 3 insertions(+), 23 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 31fe45a94..a4255f1e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -120,29 +120,9 @@ The full Meilisearch release process is described in [this guide](https://github Depending on the developed feature, you might need to provide a prototyped version of Meilisearch to make it easier to test by the users. -The prototype name must follow this convention: `prototype-X-Y` where -- `X` is the feature name formatted in `kebab-case`. It should not end with a single number. -- `Y` is the version of the prototype, starting from `0`. - -✅ Example: `prototype-auto-resize-0`.
-❌ Bad example: `auto-resize-0`: lacks the `prototype` prefix.
-❌ Bad example: `prototype-auto-resize`: lacks the version suffix.
-❌ Bad example: `prototype-auto-resize-0-0`: feature name ends with a single number. - -Steps to create a prototype: - -1. In your terminal, go to the last commit of your branch (the one you want to provide as a prototype). -2. Create a tag following the convention: `git tag prototype-X-Y` -3. Run Meilisearch and check that its launch summary features a line: `Prototype: prototype-X-Y` (you may need to switch branches and back after tagging for this to work). -3. Push the tag: `git push origin prototype-X-Y` -4. Check the [Docker CI](https://github.com/meilisearch/meilisearch/actions/workflows/publish-docker-images.yml) is now running. - -🐳 Once the CI has finished to run (~1h30), a Docker image named `prototype-X-Y` will be available on [DockerHub](https://hub.docker.com/repository/docker/getmeili/meilisearch/general). People can use it with the following command: `docker run -p 7700:7700 -v $(pwd)/meili_data:/meili_data getmeili/meilisearch:prototype-X-Y`.
-More information about [how to run Meilisearch with Docker](https://docs.meilisearch.com/learn/cookbooks/docker.html#download-meilisearch-with-docker). - -⚙️ However, no binaries will be created. If the users do not use Docker, they can go to the `prototype-X-Y` tag in the Meilisearch repository and compile from the source code. - -⚠️ When sharing a prototype with users, remind them to not use it in production. Prototypes are solely for test purposes. +This happens in two steps: +- [Release the prototype](https://github.com/meilisearch/engine-team/blob/main/resources/prototypes.md#how-to-publish-a-prototype) +- [Communicate about it](https://github.com/meilisearch/engine-team/blob/main/resources/prototypes.md#communication) ### Release assets