Skip to content

Commit 0953ec4

Browse files
author
Carlo Bernardini
authored
feat(workflow): set up standard-version and update docs (#118)
* Set up and configure standard-version (no commit linting for now) * Implement release script * Generate initial changelog * Update releasing and contributing docs
1 parent 16e3814 commit 0953ec4

5 files changed

Lines changed: 2784 additions & 1200 deletions

File tree

CHANGELOG.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
## [1.2.1](https://github.com/textkernel/oneui/compare/1.2.0...1.2.1) (2019-06-11)
2+
3+
4+
### Bug Fixes
5+
6+
* **footer:** add styling to links ([#119](https://github.com/textkernel/oneui/issues/119)) ([3f0e8ad](https://github.com/textkernel/oneui/commit/3f0e8ad))
7+
* destruct props that should not be applied as html attributes ([#117](https://github.com/textkernel/oneui/issues/117)) ([bff61c3](https://github.com/textkernel/oneui/commit/bff61c3))
8+
9+
10+
11+
# [1.2.0](https://github.com/textkernel/oneui/compare/1.1.0...1.2.0) (2019-06-06)
12+
13+
14+
### Bug Fixes
15+
16+
* design adjustments ([#109](https://github.com/textkernel/oneui/issues/109)) ([f70fbbd](https://github.com/textkernel/oneui/commit/f70fbbd))
17+
* styling for buttongroup with single button ([#111](https://github.com/textkernel/oneui/issues/111)) ([16e0d9c](https://github.com/textkernel/oneui/commit/16e0d9c))
18+
* update default footer copyright ([#113](https://github.com/textkernel/oneui/issues/113)) ([a744bfa](https://github.com/textkernel/oneui/commit/a744bfa))
19+
20+
21+
### Features
22+
23+
* add textkernel full logo ([#110](https://github.com/textkernel/oneui/issues/110)) ([a0c856d](https://github.com/textkernel/oneui/commit/a0c856d))
24+
25+
26+
27+
# [1.1.0](https://github.com/textkernel/oneui/compare/1.0.0...1.1.0) (2019-05-21)
28+
29+
30+
### Bug Fixes
31+
32+
* **button:** fix height issues with anchor-buttons in safari ([#106](https://github.com/textkernel/oneui/issues/106)) ([cd9a281](https://github.com/textkernel/oneui/commit/cd9a281))
33+
* **storybook:** initialize oneui before loading stories ([#107](https://github.com/textkernel/oneui/issues/107)) ([cc2fa8d](https://github.com/textkernel/oneui/commit/cc2fa8d))
34+
* dont use relative paths for importing bem package ([#104](https://github.com/textkernel/oneui/issues/104)) ([87061b2](https://github.com/textkernel/oneui/commit/87061b2))
35+
* **storybook:** reinstate loadingspinner label knob ([5019185](https://github.com/textkernel/oneui/commit/5019185))
36+
37+
38+
### Features
39+
40+
* chip component ([#105](https://github.com/textkernel/oneui/issues/105)) ([b07eb08](https://github.com/textkernel/oneui/commit/b07eb08))
41+
42+
43+
44+
# [1.0.0](https://github.com/textkernel/oneui/compare/0.7.0...1.0.0) (2019-05-13)
45+
46+
47+
### Bug Fixes
48+
49+
* **a11y:** accessibility improvements ([#98](https://github.com/textkernel/oneui/issues/98)) ([eaa68d7](https://github.com/textkernel/oneui/commit/eaa68d7))
50+
* remove useCallback hook from pagination ([#100](https://github.com/textkernel/oneui/issues/100)) ([25e6188](https://github.com/textkernel/oneui/commit/25e6188))
51+
52+
53+
54+
# [0.7.0](https://github.com/textkernel/oneui/compare/0.6.1...0.7.0) (2019-05-10)
55+
56+
57+
### Features
58+
59+
* **component:** pagination components ([#83](https://github.com/textkernel/oneui/issues/83)) ([3081ddf](https://github.com/textkernel/oneui/commit/3081ddf))
60+
* forward refs in form components ([#85](https://github.com/textkernel/oneui/issues/85)) ([8df551a](https://github.com/textkernel/oneui/commit/8df551a))
61+
62+
63+
### BREAKING CHANGES
64+
65+
* Ref forwarding may introduce observably different behavior
66+
67+
68+
69+
## [0.6.1](https://github.com/textkernel/oneui/compare/0.6.0...0.6.1) (2019-05-07)
70+
71+
72+
73+
# [0.6.0](https://github.com/textkernel/oneui/compare/0.5.0...0.6.0) (2019-05-01)
74+
75+
76+
### Bug Fixes
77+
78+
* **icon:** inherit color by default ([#93](https://github.com/textkernel/oneui/issues/93)) ([2ea25b5](https://github.com/textkernel/oneui/commit/2ea25b5))
79+
* **storybook:** reinstate missing knobs for loadingspinner ([#91](https://github.com/textkernel/oneui/issues/91)) ([b9d029b](https://github.com/textkernel/oneui/commit/b9d029b))
80+
81+
82+
83+
# [0.5.0](https://github.com/textkernel/oneui/compare/0.4.0...0.5.0) (2019-04-24)
84+
85+
86+
### Bug Fixes
87+
88+
* **button:** do not apply context as element attribute ([#86](https://github.com/textkernel/oneui/issues/86)) ([73d3dc9](https://github.com/textkernel/oneui/commit/73d3dc9))
89+
90+
91+
### Features
92+
93+
* **theming:** oneui themeloader ([#63](https://github.com/textkernel/oneui/issues/63)) ([ff8d34c](https://github.com/textkernel/oneui/commit/ff8d34c))
94+
95+
96+
97+
# [0.4.0](https://github.com/textkernel/oneui/compare/0.3.1...0.4.0) (2019-04-18)
98+
99+
100+
101+
## [0.3.1](https://github.com/textkernel/oneui/compare/0.3.0...0.3.1) (2019-03-27)
102+
103+
104+
105+
# [0.3.0](https://github.com/textkernel/oneui/compare/0.2.1...0.3.0) (2019-03-22)
106+
107+
108+
109+
## [0.2.1](https://github.com/textkernel/oneui/compare/0.1.0...0.2.1) (2019-02-20)
110+
111+
112+

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,5 +82,36 @@ Each implementation should be thoroughly covered with tests. DOM structure can i
8282
3. Test additional interactivity / behaviour with explicit assertions
8383
4. Strive for 100% code coverage
8484

85+
## Committing and Merging
86+
87+
### Commit Messages
88+
OneUI's [release procedure](RELEASING.md) and [changelog](CHANGELOG.md) automation heavily relies on commit messages. Commit messages should follow the [Conventional Commit](https://www.conventionalcommits.org/en/) specifications. This is critical for the release script to determine a correct new version number. An updated changelog is generated automatically on the basis of commit messages. The commit message structure should be as follows:
89+
90+
```
91+
<type>[optional scope]: <description>
92+
93+
[optional body]
94+
95+
[optional footer]
96+
```
97+
98+
Commit types include:
99+
* `feat`: A new feature (equivalent to `MINOR`)
100+
* `fix`: A bug fix (equivalent to `PATCH`)
101+
* `docs`: Changes to documentation
102+
* `test`: Changes to tests
103+
* `chore`: Other changes that dont affect source files, tests or documentation
104+
* `revert`: Reverted previous commit
105+
* `style`: Code style change (indentation, semicolons, ...)
106+
* `perf`: Performance enhancements
107+
* `refactor`: Code refactoring without changes to public API
108+
109+
Use imperative, present tense in your commit description ("change", not "changed" or "changes") without uppercases or period (.) at the end.
110+
111+
**Breaking changes** should be explicitly marked (with uppercase) in the message footer, e.g. `BREAKING CHANGE: <note>`. This will result in a new `MAJOR` package version.
112+
113+
### Merging
114+
When merging a branch, squash its commits for the changelog to be nice and tidy. Each pull request / squashed commit should eventually equal one fix / feature / change in docs or tests.
115+
85116
## Releasing
86117
The procedure for making a new release is [described here](RELEASING.md).

RELEASING.md

Lines changed: 6 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -16,39 +16,13 @@ Version numbers should not be prefixed (e.g. 1.2.3, **not** v1.2.3).
1616

1717
## Release Procedure
1818

19-
1. Make sure the local `master` branch is checked out and up to date. It should contain all the latest commits that should be included with the release.
20-
2. Determine the new version number on the basis of [semver specifications](https://semver.org).
21-
3. Update the version number in metadata files (package[-lock].json), replacing `x.x.x` with actual version number:
19+
To make a new release, simply run **`npm run release`**.
2220

23-
```bash
24-
(master) $ npm --no-git-tag-version version x.x.x
25-
(master) $ git add -u .
26-
(master) $ git commit -m "bump version number"
27-
```
28-
29-
4. Create a new annotated Git tag, replacing `x.x.x` with actual version number:
30-
31-
```bash
32-
(master) $ git tag -a x.x.x
33-
```
34-
35-
5. In the tag message, list all significant changes that come with the new release. To list all commits since last tag, run:
36-
37-
```bash
38-
(master) $ git log <lasttag>..HEAD
39-
```
40-
41-
6. Push new tag to remote, replacing `x.x.x` with actual version number:
42-
43-
```bash
44-
(master) $ git push origin master x.x.x
45-
```
46-
47-
7. Publish new package version to [NPM](https://npmjs.com/package/@textkernel/oneui):
48-
49-
```bash
50-
(master) $ npm publish --access=public
51-
```
21+
The release script will...
22+
1. ...auto determine a new version number on the basis of commit messages since last tag.
23+
2. ...update the version number in metadata files (package[-lock].json).
24+
3. ...generate an updated [CHANGELOG.md](CHANGELOG.md) on the basis of commit messages since last tag.
25+
4. ...push a new tag and publish a new package to [npm](https://npmjs.com/package/@textkernel/oneui).
5226

5327
## Storybook
5428

0 commit comments

Comments
 (0)