CityLegends Packages
This repository contains typings such as interfaces and enums for the CityLegends project.
Installation
Install the packages using the Node Package Manager.
$ npm install @citylegends-official/citylegends-packages
Development Usage
To use the package during development, create an archive using the pack command and install the packages manually in your project.
$ npm pack
$ npm install citylegends-official-citylegends-packages-x.y.z.tgz
Distribution
The package is distributed automatically to the Node Package Registry using GitHub Actions. In order to publish a new version, you'll need to push over your changes to the master branch including a version tag on the commit you'd like to build. Use the following command will do so. When you've pushed a new tag, make sure this tag matches your package's new version. Check the deployments tab on GitHub to follow the publish process.
$ npm version [<newversion> | major | minor | patch]
$ git push origin <tag_name>