Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 829 Bytes

DEVELOPING.md

File metadata and controls

26 lines (18 loc) · 829 Bytes
Raw

Development Guide

OpenAPI Code Generation

Much of the code in this project is generated by the OpenAPI generator. Regenerating the generated portions of the codebase can be done simply with this command (run this whenever new features / changes to the OpenAPI spec are released).

openapi-generator generate -i https://api.stadiamaps.com/openapi.yaml -g php --strict-spec=true -o . -p disallowAdditionalPropertiesIfNotPresent=false -p composerPackageName="stadiamaps/api" --global-property apiDocs=false,modelTests=false,modelDocs=false

Tests

Integration tests require a Stadia Maps API key. They are run automatically by CI.

export API_KEY=YOUR-API-KEY
composer install
vendor/bin/phpunit

Release

Create a GitHub release with an appropriate semantic version, and the rest is automatic!