An open API service indexing awesome lists of open source software.

https://github.com/caplin/caplin-dev-tools


https://github.com/caplin/caplin-dev-tools

Last synced: 5 months ago
JSON representation

Awesome Lists containing this project

README

        

# THIS REPO HAS NOW BEEN MERGED INTO THE CAPLIN FRONT END MONOREPO; IT IS NO LONGER BEING ACTIVELY USED

# For developing Caplin applications using node.js tooling

This monorepo contains packages that are designed to be used as part of
a Caplin development environment. They are not designed for usage in generic web
applications. The more important packages have their own README.md files.

# Releasing packages

We are using
[conventional-changelog](https://github.com/conventional-changelog/conventional-changelog)
to programatically create changelogs.

## Releasing a new version of a package

Verify the package already has a `CHANGELOG.md`, if not see below for steps to
create one.

1. Make changes
2. Commit those changes following the conventional-changelog commit style
3. `yarn run release`

#### Creation of a CHANGELOG.md

If the package you are modifying has no `CHANGELOG.md` file, then create a
`CHANGELOG.md`. First `cd` into the package folder and run:

`conventional-changelog -p angular -i CHANGELOG.md -s -r 0 --commit-path .`

You should run this **before** you make your commits and update the
`package.json` version.

Then tag the package's last release (the last time its version was updated).

`git tag [email protected] 50100c3aa8376e`

The format of the tag is `NAME_OF_PACKAGE@LAST_PUBLISHED_VERSION` and the commit
is the commit where the `package.json` version was changed.

Push the newly created tag to the server

`git push origin [email protected]`