Skip to content

Commit 4bda489

Browse files
author
George Thomas
committed
docs: update with deployment details
1 parent da9b834 commit 4bda489

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

+20
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
## Version 3 now available with zero runtime dependencies, requires Node >=14.18.0.
44

5+
# Usage
6+
57
`@brandwatch/monitoring` is Express middleware that exposes a collection of standardised endpoints for monitoring infrastructure (e.g. Prometheus) to consume.
68

79
`npm i @brandwatch/monitoring`
@@ -76,3 +78,21 @@ var c = new Counter('my_counter');
7678
setTimeout(c.inc, 200);
7779
monitoring.addMetrics(() => prometheus.register.metrics());
7880
```
81+
82+
# Deployment
83+
84+
This package is deployed to artifactory. It has no build step or dependencies.
85+
To publish a new verison of this package:
86+
87+
1. Merge changes from PR into master/main branch.
88+
2. Checkout master branch
89+
3. Version the package accordingly with [semver](https://semver.org/) `npm version major|minor|patch`
90+
4. Publish version to artifactory `npm run publish` (the `prepublishOnly` hook will ensure tests pass first)
91+
5. Commit the version change & push the tags to remote
92+
```
93+
git add .
94+
git commit -m 'chore: publish vX.X.X'
95+
git push && git push --tags
96+
```
97+
98+
Assuming all steps were successfull a new version of the package will be available for usage in consuming apps.

0 commit comments

Comments
 (0)