Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Move SEAL to CMS-IG namespace (BC Break) #458

Merged
merged 3 commits into from
Nov 16, 2024
Merged

Move SEAL to CMS-IG namespace (BC Break) #458

merged 3 commits into from
Nov 16, 2024

Conversation

alexander-schranz
Copy link
Member

@alexander-schranz alexander-schranz commented Nov 12, 2024 •
edited
Loading

fix #428

BC Breaks

To upgrade use search and replace also have a look at the .examples changes to better understand the upgrade.

  • Package names:

    • schranz-search/seal -> cmsig/seal
    • schranz-search/seal-...-adapter -> cmsig/seal-...-adapter
    • schranz-search/laravel-package -> cmsig/seal-laravel-package
    • schranz-search/mezzio-module -> cmsig/seal-mezzio-module
    • schranz-search/spiral-bridge -> cmsig/seal-spiral-bridge
    • schranz-search/yii-module -> cmsig/seal-yii-module
    • schranz-search/symfony-bundle -> cmsig/seal-symfony-bundle

  • Namespaces:

    • Schranz\Search\SEAL -> CmsIg\Seal\
    • Schranz\Search\Integration -> CmsIg\Seal\Integration

  • Config Files:

    • schranz_search.* -> cmsig_seal.*

  • Config, Service names, Tagged Services:

    • schranz_search.* -> cmsig_seal.*

  • Commands:

    • schranz:search:* -> cmsig:seal:*

  • Spiral Integration Changes:

    • SearchBootloader -> SealBootloader
    • SearchConfig -> SealConfig
    • seal.php -> cmsig_seal.php

  • Symfony Integration Changes:

    • SearchBundle -> SealBundle
    • seal.yaml -> cmsig_seal.yaml

  • Laravel Integration Changes:

    • SearchProvider -> SealProvider
    • seal.php -> cmsig_seal.php

@alexander-schranz alexander-schranz added the features New feature or request label Nov 12, 2024
alexander-schranz
alexander-schranz commented Nov 12, 2024
View reviewed changes
Copy link
Member Author

@alexander-schranz alexander-schranz left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What you think here @Toflar @bmack

integrations/symfony/src/Command/IndexCreateCommand.php Outdated
@@ -24,7 +24,7 @@
/**
* @experimental
*/
#[AsCommand(name: 'schranz:search:index-create', description: 'Create configured search indexes.')]
#[AsCommand(name: 'seal:index-create', description: 'Create configured search indexes.')]
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unsure about this one seal:index-create, cmsig-seal:index-create vs cmsig:seal:index-create

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like cmsig:seal:*. We also do this in Contao, e.g. contao:backup:create etc.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • cmsig:seal:

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I go with cmsig:seal:

integrations/symfony/src/SearchBundle.php Outdated
@@ -32,7 +32,7 @@
*/
final class SearchBundle extends AbstractBundle
{
protected string $extensionAlias = 'schranz_search';
protected string $extensionAlias = 'seal';
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unsure about this based on flysystem bundle I would go with just seal. alternative would be cmsig_seal like it is for fos_rest

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's unlikely going to be another seal but cmsig_seal would be more namespace-likey.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think "seal" is good.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to be consistent with command and namespace I also choiced here cmsig_seal

Copy link
Member Author

@alexander-schranz alexander-schranz Nov 16, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

personally think yii framework is doing the best, where module config name = composer.json name think more frameworks should adopt that.

@alexander-schranz alexander-schranz added Adapter: Elasticsearch Elasticsearch Adapter releated issue Adapter: Opensearch Opensearch Adapter related issue Adapter: Memory Memory Adapter related issue Adapter: ReadWrite ReadWrite Adapter related issue Adapter: Multi Multi Adapter related issue Adapter: Meilisearch Meilisearch Adapter related issue Adapter: Algolia Algolia Adapter related issue Adapter: Solr Solr Adapter related issue Adapter: Typesense Typesense Adapter related issue Adapter: RediSearch RediSearch Adapter related issue Integration: Symfony Symfony related issue Integration: Laravel Laravel related issue Integration: Spiral Spiral related issue DX Improves the developer experience Integration: Mezzio Mezzio related issue Integration: Yii Yii related issue Adapter: Loupe Loupe Adapter related issue and removed features New feature or request labels Nov 12, 2024
@alexander-schranz alexander-schranz added this to the 1.0.0 milestone Nov 12, 2024
@alexander-schranz alexander-schranz force-pushed the feature/cms-ig branch 6 times, most recently from 85049eb to e285a3a Compare November 16, 2024 20:46
@alexander-schranz alexander-schranz changed the title Move Seal to CmsIg namespace (BC Break) Move SEAL to CMS-IG namespace (BC Break) Nov 16, 2024
@alexander-schranz alexander-schranz force-pushed the feature/cms-ig branch 5 times, most recently from 244edf4 to 365099c Compare November 16, 2024 20:58
@alexander-schranz alexander-schranz marked this pull request as ready for review November 16, 2024 21:00
@alexander-schranz alexander-schranz merged commit 5d2f805 into PHP-CMSIG:0.6 Nov 16, 2024
5 of 32 checks passed
@alexander-schranz alexander-schranz deleted the feature/cms-ig branch November 16, 2024 21:15
@alexander-schranz alexander-schranz mentioned this pull request Nov 16, 2024
Merged
alexander-schranz added a commit that referenced this pull request Nov 16, 2024
@alexander-schranz
Add cmsig/seal packages replaces schranz-search packages (#459)
6d2d356 
after moving repositories in
#458 to php-cmsig organisation.
we can make migration easier by add replace to the composer.json.
@alexander-schranz alexander-schranz mentioned this pull request Nov 16, 2024
Closed
alexander-schranz added a commit to PHP-CMSIG/seal that referenced this pull request Nov 16, 2024
@alexander-schranz
Add cmsig/seal packages replaces schranz-search packages (#459)
bad0c69 
after moving repositories in
PHP-CMSIG/search#458 to php-cmsig organisation.
we can make migration easier by add replace to the composer.json.
alexander-schranz added a commit to PHP-CMSIG/seal-elasticsearch-adapter that referenced this pull request Nov 16, 2024
@alexander-schranz
Add cmsig/seal packages replaces schranz-search packages (#459)
14fbbdf 
after moving repositories in
PHP-CMSIG/search#458 to php-cmsig organisation.
we can make migration easier by add replace to the composer.json.
alexander-schranz added a commit to PHP-CMSIG/seal-opensearch-adapter that referenced this pull request Nov 16, 2024
@alexander-schranz
Add cmsig/seal packages replaces schranz-search packages (#459)
47782a8 
after moving repositories in
PHP-CMSIG/search#458 to php-cmsig organisation.
we can make migration easier by add replace to the composer.json.
alexander-schranz added a commit to PHP-CMSIG/seal-solr-adapter that referenced this pull request Nov 16, 2024
@alexander-schranz
Add cmsig/seal packages replaces schranz-search packages (#459)
730eccf 
after moving repositories in
PHP-CMSIG/search#458 to php-cmsig organisation.
we can make migration easier by add replace to the composer.json.
alexander-schranz added a commit to PHP-CMSIG/seal-redisearch-adapter that referenced this pull request Nov 16, 2024
@alexander-schranz
Add cmsig/seal packages replaces schranz-search packages (#459)
4df0737 
after moving repositories in
PHP-CMSIG/search#458 to php-cmsig organisation.
we can make migration easier by add replace to the composer.json.
alexander-schranz added a commit to PHP-CMSIG/seal-loupe-adapter that referenced this pull request Nov 16, 2024
@alexander-schranz
Add cmsig/seal packages replaces schranz-search packages (#459)
74bb6e7 
after moving repositories in
PHP-CMSIG/search#458 to php-cmsig organisation.
we can make migration easier by add replace to the composer.json.
alexander-schranz added a commit to PHP-CMSIG/seal-meilisearch-adapter that referenced this pull request Nov 16, 2024
@alexander-schranz
Add cmsig/seal packages replaces schranz-search packages (#459)
e172b89 
after moving repositories in
PHP-CMSIG/search#458 to php-cmsig organisation.
we can make migration easier by add replace to the composer.json.
alexander-schranz added a commit to PHP-CMSIG/seal-typesense-adapter that referenced this pull request Nov 16, 2024
@alexander-schranz
Add cmsig/seal packages replaces schranz-search packages (#459)
20c720f 
after moving repositories in
PHP-CMSIG/search#458 to php-cmsig organisation.
we can make migration easier by add replace to the composer.json.
alexander-schranz added a commit to PHP-CMSIG/seal-algolia-adapter that referenced this pull request Nov 16, 2024
@alexander-schranz
Add cmsig/seal packages replaces schranz-search packages (#459)
4532fe4 
after moving repositories in
PHP-CMSIG/search#458 to php-cmsig organisation.
we can make migration easier by add replace to the composer.json.
alexander-schranz added a commit to PHP-CMSIG/seal-memory-adapter that referenced this pull request Nov 16, 2024
@alexander-schranz
Add cmsig/seal packages replaces schranz-search packages (#459)
1dd4cb0 
after moving repositories in
PHP-CMSIG/search#458 to php-cmsig organisation.
we can make migration easier by add replace to the composer.json.
alexander-schranz added a commit to PHP-CMSIG/seal-read-write-adapter that referenced this pull request Nov 16, 2024
@alexander-schranz
Add cmsig/seal packages replaces schranz-search packages (#459)
74de5ff 
after moving repositories in
PHP-CMSIG/search#458 to php-cmsig organisation.
we can make migration easier by add replace to the composer.json.
alexander-schranz added a commit to PHP-CMSIG/seal-multi-adapter that referenced this pull request Nov 16, 2024
@alexander-schranz
Add cmsig/seal packages replaces schranz-search packages (#459)
50777a4 
after moving repositories in
PHP-CMSIG/search#458 to php-cmsig organisation.
we can make migration easier by add replace to the composer.json.
alexander-schranz added a commit to PHP-CMSIG/seal-symfony-bundle that referenced this pull request Nov 16, 2024
@alexander-schranz
Add cmsig/seal packages replaces schranz-search packages (#459)
c36665b 
after moving repositories in
PHP-CMSIG/search#458 to php-cmsig organisation.
we can make migration easier by add replace to the composer.json.
alexander-schranz added a commit to PHP-CMSIG/seal-spiral-bridge that referenced this pull request Nov 16, 2024
@alexander-schranz
Add cmsig/seal packages replaces schranz-search packages (#459)
59e6107 
after moving repositories in
PHP-CMSIG/search#458 to php-cmsig organisation.
we can make migration easier by add replace to the composer.json.
alexander-schranz added a commit to PHP-CMSIG/seal-laravel-package that referenced this pull request Nov 16, 2024
@alexander-schranz
Add cmsig/seal packages replaces schranz-search packages (#459)
ba0a069 
after moving repositories in
PHP-CMSIG/search#458 to php-cmsig organisation.
we can make migration easier by add replace to the composer.json.
alexander-schranz added a commit to PHP-CMSIG/seal-mezzio-module that referenced this pull request Nov 16, 2024
@alexander-schranz
Add cmsig/seal packages replaces schranz-search packages (#459)
8ee571b 
after moving repositories in
PHP-CMSIG/search#458 to php-cmsig organisation.
we can make migration easier by add replace to the composer.json.
alexander-schranz added a commit to PHP-CMSIG/seal-yii-module that referenced this pull request Nov 16, 2024
@alexander-schranz
Add cmsig/seal packages replaces schranz-search packages (#459)
710300b 
after moving repositories in
PHP-CMSIG/search#458 to php-cmsig organisation.
we can make migration easier by add replace to the composer.json.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Toflar Toflar Toflar left review comments

@bmack bmack bmack left review comments

Assignees
No one assigned
Labels
Adapter: Algolia Algolia Adapter related issue Adapter: Elasticsearch Elasticsearch Adapter releated issue Adapter: Loupe Loupe Adapter related issue Adapter: Meilisearch Meilisearch Adapter related issue Adapter: Memory Memory Adapter related issue Adapter: Multi Multi Adapter related issue Adapter: Opensearch Opensearch Adapter related issue Adapter: ReadWrite ReadWrite Adapter related issue Adapter: RediSearch RediSearch Adapter related issue Adapter: Solr Solr Adapter related issue Adapter: Typesense Typesense Adapter related issue DX Improves the developer experience Integration: Laravel Laravel related issue Integration: Mezzio Mezzio related issue Integration: Spiral Spiral related issue Integration: Symfony Symfony related issue Integration: Yii Yii related issue
Projects
None yet
Milestone
1.0.0
Development

Successfully merging this pull request may close these issues.

Moving to a new namespace and package name
3 participants
@alexander-schranz @bmack @Toflar