## TheOrchard Common Libraries

TheOrchard common libraries

### Installation

Installation is via composer.  Please make sure this below section is added to the composer.json file.

```
{
    "repositories": [
        {
            "type": "vcs",
            "url": "git@github.com:theorchard/common.git"
        }
    ],
    "require": {
        "orchard/common": "@stable"
    }
}
```

### Requirement

PHP >= 8.2

Note: From Version 3.0.0 onwards its not backward-compatible and has breaking changes.


### How to create a release

Please run a comparison between the last stable tag to master using this URL - https://github.com/theorchard/common/compare/2.0.9...master.  All you need to change is the source tag number - 2.0.9 in this example.

Please copy all commit messages from the comparison result and convert that into the release notes for the new version.  Please use bullet points for each note.  With that said, everyone who commits to this repo must make the commit message meaningful.  Please don't say something like this: "Fixed typo."

Once you have the release notes, go to [Releases](https://github.com/theorchard/common/releases).  Click on "Draft a new release", select the new tag. If it's not already created, enter the new version number and click on "create new tag".  Enter release title, e.g. "Release {version}".  Paste the release notes from the previous step into the release notes box.  Then choose (if necessary) Pre-release or Latest and click on Publish release or save draft.

### How to run all unit tests

```
$ docker-compose up --build unit_tests
```