Skip to content

Latest commit

 

History

History
54 lines (33 loc) · 2.53 KB

README.md

File metadata and controls

54 lines (33 loc) · 2.53 KB

Stripe Mirakl Connector

Build Status Coverage Status License: MIT

Stripe provides a connector to allow marketplaces powered by Mirakl to onboard sellers on Stripe and pay them out automatically.

Learn how to use the connector in the Stripe Docs.

Containerized examples

Deploying the application manually can be non-trivial and sometimes unstable. We recommend using containerization instead.

For Docker users, you can find an example under examples/docker.

Feel free to share a working example using your favorite tool via a pull request.

Versioning

We use the MAJOR.MINOR.PATCH semantic:

  • MAJOR versions contain incompatible API or configuration changes.
  • MINOR versions contain new functionality added in a backwards compatible manner.
  • PATCH versions contain bug fixes added in a backwards compatible manner.

Upgrading is safe for MINOR and PATCH types. For MAJOR versions, make sure to check the CHANGELOG before upgrading to see if you are affected by the breaking changes.

Downgrading is safe for MINOR and PATCH versions. You shouldn't downgrade between MAJOR versions if the connector was already used in production.

To upgrade:

  1. Delete the var folder to clean the cache.
  2. From the root of your clone, run git pull to download changes.
  3. Reinstall the connector.

To downgrade:

  1. Find the latest database migration for the targeted version in src/Migrations.
  2. Run the database migrations with that version, e.g. bin/console doctrine:migration:migrate --no-interaction 20201016122853
  3. Delete the var folder to clean the cache.
  4. From the root of your clone, run git reset to the desired commit or tag.
  5. Reinstall the connector.

If you are using Docker, see instead the specific instructions on how to upgrade and downgrade.

Contributing to the application

Pull requests are welcome. Please make sure to update tests accordingly.

License

MIT