Skip to content

Commit

Permalink
Merge branch 'main' into pr/18
Browse files Browse the repository at this point in the history
  • Loading branch information
duncanmcclean committed Oct 16, 2023
2 parents 5d90bdc + 1ad24e3 commit c91a8ac
Show file tree
Hide file tree
Showing 19 changed files with 228 additions and 272 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ A clear and concise description of what the bug is.

**Versions**
You can use `composer show` to get the version numbers of:
- elvenstar/statamic-meilisearch package version:
- statamic-rad-pack/mellisearch package version:

PHP version:
Laravel version:
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Ask a Question
url: https://github.com/elvenstar/statamic-meilisearch/discussions/new?category=q-a
url: https://github.com/statamic-rad-pack/mellisearch/discussions/new?category=q-a
about: Ask the community for help
- name: Feature Request
url: https://github.com/elvenstar/statamic-meilisearch/discussions/new?category=ideas
url: https://github.com/statamic-rad-pack/mellisearch/discussions/new?category=ideas
about: Share ideas for new features
23 changes: 0 additions & 23 deletions .github/workflows/php-cs-fixer.yml

This file was deleted.

28 changes: 28 additions & 0 deletions .github/workflows/pint-fix.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Fix PHP code style issues

on:
push:
paths:
- '**.php'

permissions:
contents: write

jobs:
fix-php-code-styling:
runs-on: ubuntu-latest
if: github.repository_owner == 'statamic-rad-pack'

steps:
- name: Checkout code
uses: actions/checkout@v3
with:
ref: ${{ github.head_ref }}

- name: Fix PHP code style issues
uses: aglipanci/laravel-pint-action@1.0.0

- name: Commit changes
uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: Fix styling
20 changes: 20 additions & 0 deletions .github/workflows/pint-lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Lint PHP code style issues

on:
pull_request:
paths:
- '**.php'

jobs:
lint-php-code-styling:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Check PHP code style issues
uses: aglipanci/laravel-pint-action@1.0.0
with:
testMode: true
verboseMode: true
3 changes: 2 additions & 1 deletion .github/workflows/run-tests.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
name: Tests

on: [push, pull_request]
# on: [push, pull_request]
on: []

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
Expand Down
43 changes: 0 additions & 43 deletions .php-cs-fixer.dist.php

This file was deleted.

33 changes: 15 additions & 18 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,29 @@

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## 2.0.1 - 2023-08-23

### What's Changed

- Remove paragraph about versioning system from readme by @lakkes-ra in https://github.com/elvenstar/statamic-meilisearch/pull/15
- Remove paragraph about versioning system from readme by @lakkes-ra in https://github.com/statamic-rad-pack/mellisearch/pull/15
- Add support for Statamic 3.3

**Full Changelog**: https://github.com/elvenstar/statamic-meilisearch/compare/2.0.0...2.0.1
**Full Changelog**: https://github.com/statamic-rad-pack/mellisearch/compare/2.0.0...2.0.1

## 2.0.0 - 2023-06-20

### What's Changed

- Allow new version of `meilisearch/meilisearch-php` by @Z3d0X in https://github.com/elvenstar/statamic-meilisearch/pull/10
- Update for MS v1.0, Statamic 4.0 and Laravel 10 by @lakkes-ra in https://github.com/elvenstar/statamic-meilisearch/pull/13
- Update Authorization Header in README by @lakkes-ra in https://github.com/elvenstar/statamic-meilisearch/pull/12
- Allow new version of `meilisearch/meilisearch-php` by @Z3d0X in https://github.com/statamic-rad-pack/mellisearch/pull/10
- Update for MS v1.0, Statamic 4.0 and Laravel 10 by @lakkes-ra in https://github.com/statamic-rad-pack/mellisearch/pull/13
- Update Authorization Header in README by @lakkes-ra in https://github.com/statamic-rad-pack/mellisearch/pull/12

### New Contributors

- @Z3d0X made their first contribution in https://github.com/elvenstar/statamic-meilisearch/pull/10
- @lakkes-ra made their first contribution in https://github.com/elvenstar/statamic-meilisearch/pull/13
- @Z3d0X made their first contribution in https://github.com/statamic-rad-pack/mellisearch/pull/10
- @lakkes-ra made their first contribution in https://github.com/statamic-rad-pack/mellisearch/pull/13

**Full Changelog**: https://github.com/elvenstar/statamic-meilisearch/compare/1.1.0...2.0.0
**Full Changelog**: https://github.com/statamic-rad-pack/mellisearch/compare/1.1.0...2.0.0

## Allow latest Meilisearch client - 2022-08-02

Expand All @@ -37,31 +34,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

**Meilisearch 0.28 has a lot of breaking changes in its api. You may need to require an older Meilisearch Client if you use an older Version of Meilisearch.**

**Full Changelog**: https://github.com/elvenstar/statamic-meilisearch/compare/1.0.6...1.1.0
**Full Changelog**: https://github.com/statamic-rad-pack/mellisearch/compare/1.0.6...1.1.0

## 1.0.6 - 2022-05-09

### Changed

- Fix missing type hint for `Statamic\Taxonomies\Term`

**Full Changelog**: https://github.com/elvenstar/statamic-meilisearch/compare/1.0.5...1.0.6
**Full Changelog**: https://github.com/statamic-rad-pack/mellisearch/compare/1.0.5...1.0.6

## 1.0.5 - 2022-05-09

### Changed

Nothing! Just a new version to release changes for real (I forgot to push before I created the previous release 🤦‍♂️)

**Full Changelog**: https://github.com/elvenstar/statamic-meilisearch/compare/1.0.4...1.0.5
**Full Changelog**: https://github.com/statamic-rad-pack/mellisearch/compare/1.0.4...1.0.5

## 1.0.4 - 2022-05-09

### Changed

- Pass `reference` and not whole object to delete method.

**Full Changelog**: https://github.com/elvenstar/statamic-meilisearch/compare/1.0.3...1.0.4
**Full Changelog**: https://github.com/statamic-rad-pack/mellisearch/compare/1.0.3...1.0.4

## 1.0.3 - 2022-05-09

Expand All @@ -75,7 +72,7 @@ Add compare url to new changelog updates

Use correct target branch for tag.

**Full Changelog**: https://github.com/elvenstar/statamic-meilisearch/compare/1.0.0...1.0.2
**Full Changelog**: https://github.com/statamic-rad-pack/mellisearch/compare/1.0.0...1.0.2

## 1.0.1 - 2022-05-09

Expand All @@ -96,7 +93,7 @@ In consultation with @tao, I have revised the adapter, and we present the first
### Changed

- We no longer follow the MeiliSearch release cycle (the search client is used so superficially that we do not expect any breaking changes here).
- The ID of the search documents will now be transformed according to the MeiliSearch rules https://github.com/elvenstar/statamic-meilisearch/pull/5 .
- The ID of the search documents will now be transformed according to the MeiliSearch rules https://github.com/statamic-rad-pack/mellisearch/pull/5 .
- The property `collection` is no longer indexed by default. If you still need it, add this transformer to your search configuration:

```php
Expand All @@ -119,7 +116,7 @@ In consultation with @tao, I have revised the adapter, and we present the first


```
- The Package Service Provider has been renamed to `StatamicMeiliSearchServiceProvider`. If you have problems updating, you may have to remove the package with `composer remove elvenstar/statamic-meilisearch` and add it again with `composer require elvenstar/statamic-meilisearch`.
- The Package Service Provider has been renamed to `StatamicMeiliSearchServiceProvider`. If you have problems updating, you may have to remove the package with `composer remove statamic-rad-pack/mellisearch` and add it again with `composer require statamic-rad-pack/mellisearch`.

### Removed

Expand Down
37 changes: 13 additions & 24 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,31 @@

Contributions are **welcome** and will be fully **credited**.

Please read and understand the contribution guide before creating an issue or pull request.
We accept contributions via Pull Requests on [Github](https://github.com/statamic-rad-pack/statamic-mellisearch).

## Viability

When requesting or submitting new features, first consider whether it might be useful to others. Open
source projects are used by many developers, who may have entirely different needs to your own. Think about
whether or not your feature is likely to be used by other users of the project.
## Pull Requests

## Procedure
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).

Before filing an issue:

- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
- Check to make sure your feature suggestion isn't already present within the project.
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
- Check the pull requests tab to ensure that the feature isn't already in progress.

Before submitting a pull request:
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.

- Check the codebase to ensure that your feature doesn't already exist.
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.

## Requirements
- **Consider our release cycle** - I try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.

If the project maintainer has any additional requirements, you will find them listed here.
- **Create feature branches** - Don't ask me to pull from your master branch.

- **[PSR-12 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-12-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.

- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.

- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.

- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
## Running Tests

- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
``` bash
vendor/bin/phpunit
```

- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.

**Happy coding**!
12 changes: 6 additions & 6 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)
MIT License

Copyright (c) Daniel Shields <daniel@karuna.co.za>
Copyright (c) 2023 Statamic Rad Pack

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand All @@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Loading

0 comments on commit c91a8ac

Please sign in to comment.