aperis-docs / react-static-plugin-aperis-doc-pages

0 stars 0 forks source link

= react-static plugin for Aperis doc pages

Used with link:https://github.com/riboseinc/aperis-doc-pages/[aperis-doc-pages].

NOTE: Currently, running on Windows is not supported.

== Development

=== Preparation

. Build this package locally + [source]

/path/to/this/repo$ yarn

In your local test project that uses this package:

. Replace this package’s path package.json + [source]

... "dependencies": [ ... "@riboseinc/react-static-plugin-aperis-doc-pages": "", ... ] ...

. Fetch updated dependency + [source]

/path/to/project$ yarn

TODO: Bundle a test project in this repository.

=== Making changes

Use Commitizen guidelines when writing commit messages.

=== Testing changes

. Rebuild this package + [source]

/path/to/this/repo$ yarn build

. Bring updated version into your test project + [source]

/path/to/project$ yarn upgrade "@riboseinc/react-static-plugin-aperis-doc-pages"

. Rebuild your test project and run tests.

=== Publishing

. Increment version in package.json appropriately with semantic versioning guidelines.

. {blank} + [source]

/path/to/this/repo$ yarn build /path/to/this/repo$ git tag -s /path/to/this/repo$ git push --follow-tags /path/to/this/repo$ cd dist /path/to/this/repo$ npm publish