From 8b98303191de6b7947751197f9f3c852607e3cb5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Mon, 20 Jun 2022 10:36:34 +0200 Subject: [PATCH] Change information place regarding release assets --- .github/workflows/README.md | 20 -------------------- CONTRIBUTING.md | 19 ++++++++++++++++--- 2 files changed, 16 insertions(+), 23 deletions(-) delete mode 100644 .github/workflows/README.md diff --git a/.github/workflows/README.md b/.github/workflows/README.md deleted file mode 100644 index ffb401a6c..000000000 --- a/.github/workflows/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# GitHub Actions Workflow for Meilisearch - -> **Note:** - -> - We do not use [cache](https://github.com/actions/cache) yet but we could use it to speed up CI - -## Workflow - -- On each pull request, we trigger `cargo test`. -- On each tag, we build: - - the tagged Docker image and publish it to Docker Hub - - the binaries for MacOS, Ubuntu, and Windows - - the Debian package -- On each stable release (`v*.*.*` tag): - - we build the `latest` Docker image and publish it to Docker Hub - - we publish the binary to Hombrew and Gemfury - -## Problems - -- We do not test on Windows because we are unable to make it work, there is a disk space problem. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9b733665c..b99a92c59 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,6 +5,7 @@ First, thank you for contributing to Meilisearch! The goal of this document is t Remember that there are many ways to contribute other than writing code: writing [tutorials or blog posts](https://github.com/meilisearch/awesome-meilisearch), improving [the documentation](https://github.com/meilisearch/documentation), submitting [bug reports](https://github.com/meilisearch/meilisearch/issues/new?assignees=&labels=&template=bug_report.md&title=) and [feature requests](https://github.com/meilisearch/product/discussions/categories/feedback-feature-proposal)... ## Table of Contents + - [Assumptions](#assumptions) - [How to Contribute](#how-to-contribute) - [Development Workflow](#development-workflow) @@ -13,7 +14,7 @@ Remember that there are many ways to contribute other than writing code: writing ## Assumptions -1. **You're familiar with [Github](https://github.com) and the [Pull Requests](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)(PR) workflow.** +1. **You're familiar with [GitHub](https://github.com) and the [Pull Requests](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)(PR) workflow.** 2. **You've read the Meilisearch [documentation](https://docs.meilisearch.com).** 3. **You know about the [Meilisearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). Please use this for help.** @@ -23,7 +24,7 @@ Remember that there are many ways to contribute other than writing code: writing 1. Ensure your change has an issue! Find an [existing issue](https://github.com/meilisearch/meilisearch/issues/) or [open a new issue](https://github.com/meilisearch/meilisearch/issues/new). * This is where you can get a feel if the change will be accepted or not. -2. Once approved, [fork the Meilisearch repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) in your own Github account. +2. Once approved, [fork the Meilisearch repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) in your own GitHub account. 3. [Create a new Git branch](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository) 4. Review the [Development Workflow](#development-workflow) section that describes the steps to maintain the repository. 5. Make your changes on your branch. @@ -45,6 +46,8 @@ We recommend using the `--release` flag to test the full performance of Meilisea cargo test ``` +This command will be triggered to each PR as a requirement for merging it. + If you get a "Too many open files" error you might want to increase the open file limit using this command: ```bash @@ -69,7 +72,7 @@ As minimal requirements, your commit message should: We don't follow any other convention, but if you want to use one, we recommend [the Chris Beams one](https://chris.beams.io/posts/git-commit/). -### Github Pull Requests +### GitHub Pull Requests Some notes on GitHub PRs: @@ -92,6 +95,16 @@ _[Read more about this](https://github.com/meilisearch/integration-guides/blob/m The full Meilisearch release process is described in [this guide](https://github.com/meilisearch/core-team/blob/main/resources/meilisearch-release.md). Please follow it carefully before doing any release. +### Release assets + +For each release, the following assets are created: +- Binaries for differents platforms (Linux, MacOS, Windows and ARM architectures) are attached to the GitHub release +- Binaries are pushed to HomeBrew and APT (not published for RC) +- Docker tags are created/updated: + - `vX.Y.Z` + - `vX.Y` (not published for RC) + - `latest` (not published for RC) +
Thank you again for reading this through, we can not wait to begin to work with you if you made your way through this contributing guide ❤️