Merge #90

90: Update README/CONTRIBUTING and npm package r=bidoubiwa a=bidoubiwa

Before open PR: 
- FInish README
- Update Contributing

fixes: #24 -> release drafter
fixes: #23 -> SDK conform headers
fixes: #21 -> Update Contributing

Co-authored-by: Charlotte Vermandel <[email protected]>
Co-authored-by: cvermand <[email protected]>
Co-authored-by: Clémentine Urquizar <[email protected]>

Author: 3 people

.github/release-draft-template.yml

@@ -0,0 +1,29 @@
+name-template: 'v$RESOLVED_VERSION 🚀'
+tag-template: 'v$RESOLVED_VERSION'
+exclude-labels:
+  - 'skip-changelog'
+version-resolver:
+  minor:
+    labels:
+      - 'breaking-change'
+  default: patch
+categories:
+  - title: 'Breaking changes ⚠️'
+    label: 'breaking-change'
+template: |
+  ## Changes
+
+  $CHANGES
+
+  Thanks again to $CONTRIBUTORS! 🎉
+no-changes-template: 'Changes are coming soon 😎'
+sort-direction: 'ascending'
+replacers:
+  - search: '/(?:and )?@dependabot-preview(?:\[bot\])?,?/g'
+    replace: ''
+  - search: '/(?:and )?@dependabot(?:\[bot\])?,?/g'
+    replace: ''
+  - search: '/(?:and )?@bors(?:\[bot\])?,?/g'
+    replace: ''
+  - search: '/(?:and )?@meili-bot,?/g'
+    replace: ''

.github/scripts/check-release.sh

@@ -0,0 +1,13 @@
+#!/bin/sh
+
+# Checking if current tag matches the package version
+current_tag=$(echo $GITHUB_REF | tr -d 'refs/tags/v')
+file_tag=$(grep '"version":' package.json | cut -d ':' -f 2- | tr -d ' ' | tr -d '"' | tr -d ',')
+if [ "$current_tag" != "$file_tag" ]; then
+  echo "Error: the current tag does not match the version in package file(s)."
+  echo "$current_tag vs $file_tag"
+  exit 1
+fi
+
+echo 'OK'
+exit 0

.github/workflows/publish.yml

@@ -0,0 +1,21 @@
+name: publish to npm
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+          registry-url: https://registry.npmjs.org/
+      - name: Check release validity
+        run: sh .github/scripts/check-release.sh
+      - name: Publish
+        run: npm publish .
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.github/workflows/release-drafter.yml

@@ -0,0 +1,16 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v5
+        with:
+          config-name: release-draft-template.yml
+        env:
+          GITHUB_TOKEN: ${{ secrets.RELEASE_DRAFTER_TOKEN }}

CONTRIBUTING.md

@@ -60,14 +60,17 @@ If you already have a running Strapi app in local, testing is possible with the
 yarn cy:open
 ```
 
-### Playgrounds
+### Run Playground
 
 To test directly your changes on the plugin in Strapi, you can run the Strapi playground:
 
 ```bash
+# Root of repository
 yarn playground:dev
 ```
 
+This command will install required dependencies and launch the app in development mode. You should be able to reach it on the [port 8000 of your localhost](http://localhost:8000/admin/).
+
 ## Git Guidelines
 
 ### Git Branches <!-- omit in toc -->
@@ -104,6 +107,25 @@ MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org
 This project integrates a bot that helps us manage pull requests merging.<br>
 _[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/guides/bors.md)._
 
+### Automated Changelogs
+
+This project integrates a tool to create automated changelogs.<br>
+_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/guides/release-drafter.md)._
+
+### How to Publish the Release
+
+⚠️ Before doing anything, make sure you got through the guide about [Releasing an Integration](https://github.com/meilisearch/integration-guides/blob/main/guides/integration-release.md).
+
+Make a PR modifying the file [`package.json`](/package.json) with the right version.
+
+```javascript
+"version": "X.X.X",
+```
+
+Once the changes are merged on `main`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/strapi-plugin-meilisearch/releases).
+
+GitHub Actions will be triggered and push the package to [npm](https://www.npmjs.com/package/strapi-plugin-meilisearch).
+
 <hr>
 
 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 ❤️