Contributing

Development

Run examples from the examples/ directory.

Run the default local test workflow (lint + phpcs + unit tests):

composer run test

Run lint only:

composer lint

Run static analysis separately:

composer psalm

Run phpunit tests on a single internal package:

vendor/bin/phpunit packages/mediawiki-api-base/tests/unit

Integration tests are facilitated by the docker-compose-ci.yml file. Run it before running integration tests.

docker compose -f docker-compose-ci.yml up -d --build

Wait for the wiki to be accessible, then run the tests:

composer phpunit-integration

To publish a new release:

Determine the new semantic version number.
Update RELEASENOTES.md with details of the release.
Create a tag (either locally or on GitHub) with a name matching v*.*.*.
Push the tag to GitHub, where the release.yaml workflow will create a new Release.

Packagist will be updated automatically.