First of all, thank you for contributing to Meilisearch! The goal of this document is to provide everything you need to know in order to contribute to Meilisearch and its different integrations.
- Assumptions
- How to Contribute
- Development Workflow
- Git Guidelines
- Release Process (for internal team only)
- You're familiar with GitHub and the Pull Request (PR) workflow.
- You've read the Meilisearch documentation and the README.
- You know about the Meilisearch community. Please use this for help.
- Make sure that the contribution you want to make is explained or detailed in a GitHub issue! Find an existing issue or open a new one.
- Once done, fork the firestore-meilisearch repository in your own GitHub account. Ask a maintainer if you want your issue to be checked before making a PR.
- Create a new Git branch.
- Review the Development Workflow section that describes the steps to maintain the repository.
- Make the changes on your branch.
- Submit the branch as a PR pointing to the
main
branch of the main meilisearch-js repository. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer.
We do not enforce a naming convention for the PRs, but please use something descriptive of your changes, having in mind that the title of your PR will be automatically added to the next release changelog. - You will need to build the project with
yarn build
before pushing files. - Don't forget to add
js
files from the./lib/
directory to your PR.
To run this project, you will need:
- Node >= 20
- Npm >= v7
- A google account
- Version
v10.9.2
offirebase-tools
the Firebase CLI (latest does not provide the emulator):Add the directory for the commands of the packages installed globally in yarn, to access of firebase binary:yarn global add [email protected]
export PATH="$(yarn global bin):$PATH"
Sign in with your Google Account:
firebase login
Enable the extension developer commands:
firebase --open-sesame extdev
Install dependencies:
yarn install:functions
Build the project:
yarn build
Launch Meilisearch instance:
curl -L https://install.meilisearch.com | sh # download Meilisearch
./meilisearch --master-key=masterKey --no-analytics # run Meilisearch
You may need to install Java to run the emulator.
Set emulator:
firebase init emulators
Launch emulator:
firebase ext:dev:emulators:start --test-params=test-params-example.env --import=dataset --project=name-of-the-project
or just
yarn emulator
The emulator runs with environment parameters found in test-params-example.env
and with a provided dataset found in /dataset
.
Once it is running, open the emulator in a browser at the following address: http://localhost:4000
NB: If you want to change your Meilisearch credentials or the plugins options you need to edit the test-params-example.env
file.
Each PR should pass the tests and the linter to be accepted.
curl -L https://install.meilisearch.com | sh # download Meilisearch
./meilisearch --master-key=masterKey --no-analytics # run Meilisearch
# Tests
yarn test
# Tests in watch mode
yarn test:watch
# Linter
yarn lint
# Linter with fixing
yarn lint:fix
# Build the project
yarn build
-
Set up credentials. The import script uses the application's default credentials to communicate with Firebase. Please follow the instructions generate a private key file for your service account.
-
Run the import script interactively and run ONE of the following commands:
-
Run interactively:
yarn run-cli
-
Or run non-interactively with paramaters:
yarn run-cli \ --project <project_id> \ --source-collection-path <collection_name> \ --index <index_uid> \ --batch-size <100/default=300> \ --host <host_address> \ --api-key <api_key> \ --fields-to-index <fields_to_index> \ --non-interactive
Note: The
--batch-size
and--query-collection-group
arguments are optional. To see its usage, run the above command with--help
.
-
-
Run the project for development: Launch Meilisearch instance:
curl -L https://install.meilisearch.com | sh # download Meilisearch
./meilisearch --master-key=masterKey --no-analytics # run Meilisearch
Launch the watcher on the project:
yarn watch
Launch the watcher on the script. You have to modify the informations of the playground script by your own parameters inside the package.json
file:
yarn playground
The Firebase CLI offers the possibility of automatically generating the README.md
file with the following command:
firebase ext:info ./path/to/extension --markdown > README.md
Note: Be careful this will only regenerate the text of the central part of the README.md
from the Title: Search in your Firestore content with Meilisearch
to the **Cloud Functions:**
section.
All changes must be made in a branch and submitted as PR. We do not enforce any branch naming style, but please use something descriptive of your changes.
As minimal requirements, your commit message should:
- be capitalized
- not finish by a dot or any other punctuation character (!,?)
- start with a verb so that we can read your commit message this way: "This commit will ...", where "..." is the commit message. e.g.: "Fix the home page button" or "Add more tests for create_index method"
We don't follow any other convention, but if you want to use one, we recommend this one.
Some notes on GitHub PRs:
- Convert your PR as a draft if your changes are a work in progress: no one will review it until you pass your PR as ready for review.
The draft PR can be very useful if you want to show that you are working on something and make your work visible. - The branch related to the PR must be up-to-date with
main
before merging. Fortunately, this project integrates a bot to automatically enforce this requirement without the PR author having to do it manually. - All PRs must be reviewed and approved by at least one maintainer.
- The PR title should be accurate and descriptive of the changes. The title of the PR will be indeed automatically added to the next release changelogs.
Meilisearch tools follow the Semantic Versioning Convention.
This project integrates a bot that helps us manage pull requests merging.
Read more about this.
This project integrates a tool to create automated changelogs.
Read more about this.
Make a PR modifying the files with the right version.
Either by running version.sh
with the new version. Example: sh script/version.sh 0.3.1
or by updating manually the following files:
package.json
.package.json
in the functions directory.extension.yaml
.version.ts
.
Update the CHANGELOG.md
file by creating a new section at the bottom ## Version X.X.X
. You can take inspiration from the release draft.
- Once the changes are merged on
main
, you can publish the current draft release via the GitHub interface: on this page, click onEdit
(related to the draft release) > update the description (be sure you apply this recommandation) > when you are ready, click onPublish release
.
GitHub Actions will be triggered and push the package to npm and to firebase.
- Test the newly released package on npm by launching it with
npx
:
npx firestore-meilisearch
- Publish the extension by running the following command in the root of the extension directory:
firebase ext:dev:publish meilisearch/firestore-meilisearch
Note: meilisearch
is the publisher id
for this extension.
Here are the steps to release a beta version of this package:
-
Create a new branch containing the "beta" changes with the following format
xxx-beta
wherexxx
explains the context.For example:
-
When implementing a beta feature, create a branch
my-feature-beta
where you implement the feature.git checkout -b my-feature-beta
-
During the Meilisearch pre-release, create a branch originating from
bump-meilisearch-v*.*.*
namedbump-meilisearch-v*.*.*-beta
.
v*.*.*
is the next version of the package, NOT the version of Meilisearch!git checkout bump-meilisearch-v*.*.* git pull origin bump-meilisearch-v*.*.* git checkout -b bump-meilisearch-v*.*.*-beta
-
-
Change the version in the relevant files (see how to publish the release section above) and commit it to the
beta
branch. -
Go to the GitHub interface for releasing: on this page, click on
Draft a new release
. -
Create a GitHub pre-release:
- Fill the description with the detailed changelogs
- Fill the title with
vX.X.X-beta.0
- Fill the tag with
vX.X.X-beta.0
⚠️ Select thevX.X.X-beta.0
branch and NOTmain
⚠️ Click on the "This is a pre-release" checkbox- Click on "Publish release"
GitHub Actions will be triggered and push the beta version to npm.
💡 If you need to release a new beta for the same version (i.e. vX.X.X-beta.1
):
- merge the change into
bump-meilisearch-v*.*.*
- rebase the
vX.X.X-beta.0
branch - change the version name in the relevant files (see how to publish the release section above)
- creata a pre-release via the GitHub interface
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 ❤️