Skip to content

Commit 3dbbf29

Browse files
meili-bors[bot]meili-botbrunoocasali
authored
Merge #445
445: Add yaml linting check in CI r=brunoocasali a=meili-bot _This PR is auto-generated._ To avoid mistakes in the `yaml` files, for example, duplicated keys or wrong indentation, we decided to add a lint check on `yaml` files. Additional to the `.yamllint` files added in this pr, the following must be added as well: - Linting check in CI: Example in `tests.yml create a new job: ```yaml yaml-lint: name: Yaml linting check runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - name: Yaml lint check uses: ibiqlik/action-yamllint@v3 with: config_file: .yamllint.yml ``` - Inside `.yamllint`, you might want to ignore some folders. For example `node_modules` in JS repos Example in `.yamllint`: ```yaml ignore: | node_modules ```` Since `yamllint` is a python package, we cannot add a local check unless you download [`.yamllint`](https://github.com/adrienverge/yamllint). In which case, you can check if the yaml files are correctly linted by running the following command: `yamllint .` Additionally, you can use the VSCode extension [`YAML` by redhat](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) which automatically highlights errors. To help users be aware of this, we recommend adding this to your contributing guide: ``` To check if your `yaml` files are correctly formatted, you need to [install yamllint](https://yamllint.readthedocs.io/en/stable/quickstart.html#installing-yamllint) and then run `yamllint .` ```` ## TODO - [ ] Add the directories or files to ignore in `.yamllint` - [ ] Add information in the contributing guide on this new check. Co-authored-by: meili-bot <[email protected]> Co-authored-by: Bruno Casali <[email protected]>
2 parents 81d453b + 969dd71 commit 3dbbf29

File tree

7 files changed

+91
-72
lines changed

7 files changed

+91
-72
lines changed

‎.code-samples.meilisearch.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
---
66
get_documents_post_1: |-
77
client.index('books').get_documents(
8-
filter: '(rating > 3 AND (genres = Adventure OR genres = Fiction)) AND language = English',
9-
limit: 3,
8+
filter: '(rating > 3 AND (genres = Adventure OR genres = Fiction)) AND language = English',
9+
limit: 3,
1010
fields: ['title', 'genres', 'rating', 'language']
1111
)
1212
delete_documents_by_filter_1: |-
1313
client.index('movies').get_documents(filter: 'genres = action OR genres adventure')
14-
get_documents_1: |-
14+
get_documents_1: |-
1515
client.index('movies').get_documents(limit: 2, filter: 'genres = action')
1616
getting_started_faceting: |-
1717
client.index('movies').update_faceting(max_values_per_facet: 2)

‎.github/dependabot.yml‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
version: 2
22
updates:
3-
- package-ecosystem: "github-actions"
4-
directory: "/"
5-
schedule:
6-
interval: "monthly"
7-
labels:
8-
- 'skip-changelog'
9-
- 'dependencies'
10-
rebase-strategy: disabled
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
schedule:
6+
interval: "monthly"
7+
labels:
8+
- 'skip-changelog'
9+
- 'dependencies'
10+
rebase-strategy: disabled
1111

12-
- package-ecosystem: bundler
13-
directory: "/"
14-
schedule:
15-
interval: "monthly"
16-
time: "04:00"
17-
open-pull-requests-limit: 10
18-
labels:
19-
- skip-changelog
20-
- dependencies
21-
rebase-strategy: disabled
12+
- package-ecosystem: bundler
13+
directory: "/"
14+
schedule:
15+
interval: "monthly"
16+
time: "04:00"
17+
open-pull-requests-limit: 10
18+
labels:
19+
- skip-changelog
20+
- dependencies
21+
rebase-strategy: disabled

‎.github/workflows/gempush.yml‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,20 @@ jobs:
1111
runs-on: ubuntu-20.04
1212

1313
steps:
14-
- uses: actions/checkout@v3
15-
- name: Set up Ruby 2.6
16-
uses: actions/setup-ruby@v1
17-
with:
18-
ruby-version: 2.6.x
19-
- name: Check release validity
20-
run: sh .github/scripts/check-release.sh
21-
- name: Publish to RubyGems
22-
run: |
23-
mkdir -p $HOME/.gem
24-
touch $HOME/.gem/credentials
25-
chmod 0600 $HOME/.gem/credentials
26-
printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
27-
gem build meilisearch.gemspec
28-
gem push *.gem
29-
env:
30-
GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}
14+
- uses: actions/checkout@v3
15+
- name: Set up Ruby 2.6
16+
uses: actions/setup-ruby@v1
17+
with:
18+
ruby-version: 2.6.x
19+
- name: Check release validity
20+
run: sh .github/scripts/check-release.sh
21+
- name: Publish to RubyGems
22+
run: |
23+
mkdir -p $HOME/.gem
24+
touch $HOME/.gem/credentials
25+
chmod 0600 $HOME/.gem/credentials
26+
printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
27+
gem build meilisearch.gemspec
28+
gem push *.gem
29+
env:
30+
GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

‎.github/workflows/pre-release-tests.yml‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,16 @@ jobs:
1717
name: integration-tests-against-rc (ruby ${{ matrix.ruby-version }})
1818
runs-on: ubuntu-20.04
1919
steps:
20-
- uses: actions/checkout@v3
21-
- name: Set up Ruby ${{ matrix.ruby-version }}
22-
uses: ruby/setup-ruby@v1
23-
with:
24-
ruby-version: ${{ matrix.ruby-version }}
25-
- name: Install ruby dependencies
26-
run: bundle install --with test
27-
- name: Get the latest Meilisearch RC
28-
run: echo "MEILISEARCH_VERSION=$(curl https://raw.githubusercontent.com/meilisearch/integration-guides/main/scripts/get-latest-meilisearch-rc.sh | bash)" >> $GITHUB_ENV
29-
- name: Meilisearch (${{ env.MEILISEARCH_VERSION }}) setup with Docker
30-
run: docker run -d -p 7700:7700 getmeili/meilisearch:${{ env.MEILISEARCH_VERSION }} meilisearch --master-key=masterKey --no-analytics
31-
- name: Run test suite
32-
run: bundle exec rspec
20+
- uses: actions/checkout@v3
21+
- name: Set up Ruby ${{ matrix.ruby-version }}
22+
uses: ruby/setup-ruby@v1
23+
with:
24+
ruby-version: ${{ matrix.ruby-version }}
25+
- name: Install ruby dependencies
26+
run: bundle install --with test
27+
- name: Get the latest Meilisearch RC
28+
run: echo "MEILISEARCH_VERSION=$(curl https://raw.githubusercontent.com/meilisearch/integration-guides/main/scripts/get-latest-meilisearch-rc.sh | bash)" >> $GITHUB_ENV
29+
- name: Meilisearch (${{ env.MEILISEARCH_VERSION }}) setup with Docker
30+
run: docker run -d -p 7700:7700 getmeili/meilisearch:${{ env.MEILISEARCH_VERSION }} meilisearch --master-key=masterKey --no-analytics
31+
- name: Run test suite
32+
run: bundle exec rspec

‎.github/workflows/tests.yml‎

Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -21,28 +21,38 @@ jobs:
2121
name: integration-tests (ruby ${{ matrix.ruby-version }})
2222
runs-on: ubuntu-20.04
2323
steps:
24-
- uses: actions/checkout@v3
25-
- name: Set up Ruby ${{ matrix.ruby-version }}
26-
uses: ruby/setup-ruby@v1
27-
with:
28-
ruby-version: ${{ matrix.ruby-version }}
29-
- name: Install ruby dependencies
30-
run: bundle install --with test
31-
- name: Meilisearch (latest) setup with Docker
32-
run: docker run -d -p 7700:7700 getmeili/meilisearch:latest meilisearch --master-key=masterKey --no-analytics
33-
- name: Run test suite
34-
run: bundle exec rspec
24+
- uses: actions/checkout@v3
25+
- name: Set up Ruby ${{ matrix.ruby-version }}
26+
uses: ruby/setup-ruby@v1
27+
with:
28+
ruby-version: ${{ matrix.ruby-version }}
29+
- name: Install ruby dependencies
30+
run: bundle install --with test
31+
- name: Meilisearch (latest) setup with Docker
32+
run: docker run -d -p 7700:7700 getmeili/meilisearch:latest meilisearch --master-key=masterKey --no-analytics
33+
- name: Run test suite
34+
run: bundle exec rspec
3535

3636
linter_check:
3737
name: linter-check
3838
runs-on: ubuntu-20.04
3939
steps:
40-
- uses: actions/checkout@v3
41-
- name: Set up Ruby
42-
uses: ruby/setup-ruby@v1
43-
with:
44-
ruby-version: 3.0
45-
- name: Install ruby dependencies
46-
run: bundle install --with test
47-
- name: Run linter
48-
run: bundle exec rubocop lib/ spec/
40+
- uses: actions/checkout@v3
41+
- name: Set up Ruby
42+
uses: ruby/setup-ruby@v1
43+
with:
44+
ruby-version: 3.0
45+
- name: Install ruby dependencies
46+
run: bundle install --with test
47+
- name: Run linter
48+
run: bundle exec rubocop lib/ spec/
49+
50+
yaml-lint:
51+
name: Yaml linting check
52+
runs-on: ubuntu-latest
53+
steps:
54+
- uses: actions/checkout@v3
55+
- name: Yaml lint check
56+
uses: ibiqlik/action-yamllint@v3
57+
with:
58+
config_file: .yamllint.yml

‎.yamllint.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
extends: default
2+
ignore: |
3+
node_modules
4+
rules:
5+
comments-indentation: disable
6+
line-length: disable
7+
document-start: disable
8+
brackets: disable
9+
truthy: disable

‎docker-compose.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ services:
2222
- bundle:/vendor/bundle
2323

2424
meilisearch:
25-
image: getmeili/meilisearch:latest
25+
image: getmeili/meilisearch:v1.3.0
2626
ports:
2727
- "7700"
2828
environment:

0 commit comments

Comments
 (0)