@brightspace-ui/intl 3.15.1 → 3.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -38
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -258,7 +258,11 @@ const separator = getSeparator({ nonBreaking: true }); // -> ',\xa0' in en-US
|
|
|
258
258
|
Options:
|
|
259
259
|
- **nonBreaking**: a Boolean flag, whether to use non-breaking spaces instead of standard spaces; default is `false`
|
|
260
260
|
|
|
261
|
-
##
|
|
261
|
+
## Developing and Contributing
|
|
262
|
+
|
|
263
|
+
After cloning the repo, run `npm install` to install dependencies.
|
|
264
|
+
|
|
265
|
+
### Running the test harness
|
|
262
266
|
|
|
263
267
|
Start a [@web/dev-server](https://modern-web.dev/docs/dev-server/overview/) that hosts the test harness:
|
|
264
268
|
|
|
@@ -268,45 +272,12 @@ npm start
|
|
|
268
272
|
|
|
269
273
|
This will let you test the intl library in a browser, and will update live with any changes.
|
|
270
274
|
|
|
271
|
-
|
|
275
|
+
### Contributing
|
|
272
276
|
|
|
273
277
|
Contributions are welcome, please submit a pull request!
|
|
274
278
|
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
> TL;DR: Commits prefixed with `fix:` and `feat:` will trigger patch and minor releases when merged to `main`. Read on for more details...
|
|
278
|
-
|
|
279
|
-
The [semantic-release GitHub Action](https://github.com/BrightspaceUI/actions/tree/main/semantic-release) is called from the `release.yml` GitHub Action workflow to handle version changes and releasing.
|
|
280
|
-
|
|
281
|
-
### Version Changes
|
|
282
|
-
|
|
283
|
-
All version changes should obey [semantic versioning](https://semver.org/) rules:
|
|
284
|
-
1. **MAJOR** version when you make incompatible API changes,
|
|
285
|
-
2. **MINOR** version when you add functionality in a backwards compatible manner, and
|
|
286
|
-
3. **PATCH** version when you make backwards compatible bug fixes.
|
|
287
|
-
|
|
288
|
-
The next version number will be determined from the commit messages since the previous release. Our semantic-release configuration uses the [Angular convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular) when analyzing commits:
|
|
289
|
-
* Commits which are prefixed with `fix:` or `perf:` will trigger a `patch` release. Example: `fix: validate input before using`
|
|
290
|
-
* Commits which are prefixed with `feat:` will trigger a `minor` release. Example: `feat: add toggle() method`
|
|
291
|
-
* To trigger a MAJOR release, include `BREAKING CHANGE:` with a space or two newlines in the footer of the commit message
|
|
292
|
-
* Other suggested prefixes which will **NOT** trigger a release: `build:`, `ci:`, `docs:`, `style:`, `refactor:` and `test:`. Example: `docs: adding README for new component`
|
|
293
|
-
|
|
294
|
-
To revert a change, add the `revert:` prefix to the original commit message. This will cause the reverted change to be omitted from the release notes. Example: `revert: fix: validate input before using`.
|
|
295
|
-
|
|
296
|
-
### Releases
|
|
297
|
-
|
|
298
|
-
When a release is triggered, it will:
|
|
299
|
-
* Update the version in `package.json`
|
|
300
|
-
* Tag the commit
|
|
301
|
-
* Create a GitHub release (including release notes)
|
|
302
|
-
* Deploy a new package to NPM
|
|
303
|
-
|
|
304
|
-
### Releasing from Maintenance Branches
|
|
305
|
-
|
|
306
|
-
Occasionally you'll want to backport a feature or bug fix to an older release. `semantic-release` refers to these as [maintenance branches](https://semantic-release.gitbook.io/semantic-release/usage/workflow-configuration#maintenance-branches).
|
|
279
|
+
### Versioning and Releasing
|
|
307
280
|
|
|
308
|
-
|
|
281
|
+
This repo is configured to use `semantic-release`. Commits prefixed with `fix:` and `feat:` will trigger patch and minor releases when merged to `main`.
|
|
309
282
|
|
|
310
|
-
|
|
311
|
-
* `1.15.x` for patch releases on top of the `1.15` release (after version `1.16` exists)
|
|
312
|
-
* `2.x` for feature releases on top of the `2` release (after version `3` exists)
|
|
283
|
+
To learn how to create major releases and release from maintenance branches, refer to the [semantic-release GitHub Action](https://github.com/BrightspaceUI/actions/tree/main/semantic-release) documentation.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@brightspace-ui/intl",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.16.0",
|
|
4
4
|
"description": "Internationalization APIs for number, date, time and file size formatting and parsing in D2L Brightspace.",
|
|
5
5
|
"main": "lib/number.js",
|
|
6
6
|
"type": "module",
|
|
@@ -39,7 +39,7 @@
|
|
|
39
39
|
"devDependencies": {
|
|
40
40
|
"@babel/core": "^7",
|
|
41
41
|
"@babel/eslint-parser": "^7",
|
|
42
|
-
"@web/dev-server": "^0.
|
|
42
|
+
"@web/dev-server": "^0.4",
|
|
43
43
|
"chai": "^4",
|
|
44
44
|
"concurrently": "^8",
|
|
45
45
|
"eslint": "^8",
|