Skip to content

Commit 5e7f7cc

Browse files
committed
Docs: Reformat changelog through the "keep a changelog" convention
1 parent dce6459 commit 5e7f7cc

File tree

4 files changed

+37
-48
lines changed

4 files changed

+37
-48
lines changed

CHANGELOG.md

Lines changed: 30 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -2,57 +2,45 @@
22
1.2.3 / 2020-09-07
33
==================
44

5-
* Helpers: Correct spelling in `autoRegister()` error message. (P. Roebuck) [#108](https://github.com/js-reporters/js-reporters/issues/108)
6-
* Reporter: Align `actual` with `expected` in TapReporter. (Robert Jackson) [#107](https://github.com/js-reporters/js-reporters/pull/107)
7-
* Reporter: Revert "Fix YAML output in TAP reporter". [#110](https://github.com/js-reporters/js-reporters/issues/110)
5+
### Changed
6+
7+
* Reporter: Align `actual` with `expected` in TAP reporter. (Robert Jackson) [#107](https://github.com/js-reporters/js-reporters/pull/107)
8+
9+
### Fixed
10+
11+
* Reporter: Correct spelling in `autoRegister()` error message. (P. Roebuck) [#108](https://github.com/js-reporters/js-reporters/issues/108)
12+
* Reporter: Revert "Fix YAML output in TAP reporter". [#110](https://github.com/js-reporters/js-reporters/issues/110)
813

914
1.2.2 / 2019-05-13
1015
==================
1116

12-
* Reporter: Fix YAML output in TAP reporter. [#110](https://github.com/js-reporters/js-reporters/issues/110)
17+
### Fixed
18+
19+
* Reporter: Fix YAML output in TAP reporter. (jeberger) [#110](https://github.com/js-reporters/js-reporters/issues/110)
1320

1421
1.2.1 / 2017-07-04
1522
==================
1623

17-
* Reporter: Print "actual:", "expected:" even if they are undefined
18-
* Reporter: Drop accidentally committed console.warn()
19-
* Readme: Use canonical path to QUnit repository (#99)
20-
* Readme: Add note about potential assertion memory leaks
21-
* Readme: Improve formatting of bullets
22-
* Release: Add documentation for release process
24+
### Changed
25+
26+
* Reporter: Print "actual:", "expected:" in the TAP reporeter even if undefined. (Martin Olsson)
27+
28+
### Fixed
29+
30+
* Reporter: Drop accidentally committed `console.warn()` statement. (Martin Olsson)
2331

2432
1.2.0 / 2017-03-22
2533
==================
2634

27-
* Testing: Update Node versions on Travis
28-
* TapReporter: Further improve information and styling
29-
* Deps: Explicitly include webpack to fulfill peerDep
30-
* Data: Add todo data and update tests
31-
* TapReporter: Update with more information and support todo tests
32-
* README: Specify data for todo tests
33-
* README: update
34-
* Helpers: add create functions
35-
* Index.js: add comma
36-
* README: update spec with start and end
37-
* All: break Suite and Test into start and end objects
38-
* Deps: lock Jasmine version
39-
* Helpers: update Jasmine adapter instantiation.
40-
* Helpers: export each helper function
41-
* Testing: use global instead of GLOBAL in helpers
42-
* Testing: unit testing also in the browser with help of karma
43-
* Docs: update autoRegister description
44-
* Docs: add API section
45-
* Helpers: change export
46-
* Helpers: update error message
47-
* Testing: add before and after hooks for helpers
48-
* Helpers: add docs to the autoRegister function
49-
* Testing: finish unit tests for the autoRegister function
50-
* Testing: add unit tests for autoRegister function
51-
* Bundling: export autoRegister function
52-
* Helpers: add autoregister function
53-
* Deps: restore Jasmine to last versions.
54-
* Testing: update failing versions
55-
* Deps: set jasmine to the last working version
56-
* Deps: remove jasmine-core
57-
* JasmineAdapter: fix reporter adding
58-
* README: add first example
35+
### Added
36+
37+
* Reporter: Improve TAP information and styling. (Florentin Simion)
38+
* Reporter: Support todo test in TAP reporter. (Trent Willis)
39+
* Docs: Add API section about the js-reporters package. (Florentin Simion)
40+
41+
### Changed
42+
43+
* Spec: Split "Suite" and "Test" objects into separate start and end objects. (Florentin Simion)
44+
* Spec: Define "todo test". (Trent Willis)
45+
* Test: Finish test coverage of `autoRegister` method. (Florentin Simion)
46+
* Test: Update to integration with the latest Jasmine version. (Florentin Simion)

RELEASE.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
# Release Process
22

3-
1. Update `CHANGELOG.md` using `git changelog` from the [`git-extras`](https://github.com/tj/git-extras) package. Edit the changelog file as needed, and stage the changes.
3+
1. Update `CHANGELOG.md`
4+
* Run the following command, substituting `v1.2.3` for the last release tag.
5+
`git log --format="* %s. (%aN)" --no-merges v1.2.3...HEAD | sort`
6+
* Copy the output to a changelog section at the top of the file.
7+
* Remove entries that don't affect end-users (e.g. "Build", "Test").
8+
* Format using [Keep a changelog](https://keepachangelog.com/en/1.0.0/) conventions.
49
2. Update `package.json` version, and stage the changes.
510
3. Commit with message `Release X.Y.Z`, and create a signed tag `git tag -s "vX.Y.Z" -m "Release X.Y.Z"`
611
4. Push the commit and tag to GitHub.

package.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,6 @@
3333
"nohook": true,
3434
"components": [
3535
"Build",
36-
"Changelog",
37-
"Readme",
3836
"Release",
3937
"Reporter",
4038
"Test",

test/fixtures/integration/qunit.js

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
/* global QUnit */
22

3-
// Add dummy assertions in passing tests, because QUnit is checking for at
4-
// least one assertion, if there is none, then QUnit throws an error and the
5-
// test fails.
3+
// Add dummy assertions in passing tests, as QUnit by defaul requires at least one assertion.
64

75
QUnit.test('global test', function (assert) {
86
assert.ok(true);

0 commit comments

Comments
 (0)