Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add changelog and mechanism to update it on release #37

Merged
merged 1 commit into from
Apr 7, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions .release-it.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
{
"hooks": {
"after:init": ["npm test", "npm run lint"]
"after:init": ["npm test", "npm run lint"],
"before:release": "npx auto-changelog --package --commit-limit false --template src/changelog.hbs --commit-url https://github.com/w3c/browser-specs/commit/{id} --issue-url https://github.com/w3c/browser-specs/issues/{id} --merge-url https://github.com/w3c/browser-specs/pull/{id} --compare-url https://github.com/w3c/browser-specs/compare/{from}...{to}"
},
"git": {
"commitMessage": "v${version}",
"tagName": "v${version}",
"tagAnnotation": "v${version}",
"pushRepo": "git@github.com:w3c/browser-specs.git"
"pushRepo": "git@github.com:w3c/browser-specs.git",
"changelog": "npx auto-changelog --stdout --commit-limit false --unreleased --template src/changelog-release.hbs --commit-url https://github.com/w3c/browser-specs/commit/{id} --issue-url https://github.com/w3c/browser-specs/issues/{id} --merge-url https://github.com/w3c/browser-specs/pull/{id} --compare-url https://github.com/w3c/browser-specs/compare/{from}...{to}"
},
"github": {
"release": true,
Expand Down
46 changes: 46 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Changelog

All changes to this project will be documented in this file. Commits titled
"Update spec info" are generated automatically and contain updates to spec
property values. Check the corresponding Git commit for details.

## 0.1.0 - 2020-04-07

### Merged

- Rename xxxInSeries to seriesXxx [`#34`](https://github.com/w3c/browser-specs/pull/34)
- Add code to manage releases [`#33`](https://github.com/w3c/browser-specs/pull/33)
- Add first list of specs [`#26`](https://github.com/w3c/browser-specs/pull/26)
- Align property names with W3C API [`#31`](https://github.com/w3c/browser-specs/pull/31)
- Add open source license [`#30`](https://github.com/w3c/browser-specs/pull/30)
- Export completed list of specs in index.json file [`#29`](https://github.com/w3c/browser-specs/pull/29)
- Fetch spec info from W3C API, Specref or the spec [`#22`](https://github.com/w3c/browser-specs/pull/22)
- Add filtering param for index.js when used as CLI [`#21`](https://github.com/w3c/browser-specs/pull/21)
- Fix currentLevel computation for delta specs [`#20`](https://github.com/w3c/browser-specs/pull/20)
- Add currentLevel property [`#18`](https://github.com/w3c/browser-specs/pull/18)
- Allow delta flag and add previous/next links [`#8`](https://github.com/w3c/browser-specs/pull/8)
- Add logic to compute shortname, family name and level [`#7`](https://github.com/w3c/browser-specs/pull/7)
- Detect and drop duplicate URLs when linting [`#6`](https://github.com/w3c/browser-specs/pull/6)
- Fix nits/typos from "Allow specs to be represented by a simple string" [`#4`](https://github.com/w3c/browser-specs/pull/4)
- Allow specs to be represented by a simple string [`#3`](https://github.com/w3c/browser-specs/pull/3)
- Add specs.json with a single spec and linting [`#2`](https://github.com/w3c/browser-specs/pull/2)

### Commits

- [data] Update spec info [`6637d3e`](https://github.com/w3c/browser-specs/commit/6637d3e3dcb8c777acde21958bb81934e6f01815)
- [data] Update spec info [`d5fb4f1`](https://github.com/w3c/browser-specs/commit/d5fb4f1851639b204fb966f9fd651efe04fa73c2)
- Add tests for linter [`55acd74`](https://github.com/w3c/browser-specs/commit/55acd74fa1244c9645d0b6273b8a5d5c974b1cf4)
- Add JSON Schema and schema validation to linting logic [`82aeffd`](https://github.com/w3c/browser-specs/commit/82aeffde8b5f517fe8a78e6aac887fee06b8f53f)
- Fix linting tests on duplication to pass shortname generation [`7a437ab`](https://github.com/w3c/browser-specs/commit/7a437abfc36b95b16132db8f2425fa4e8cdbbdbc)
- Simplify string detection logic [`6f77ab1`](https://github.com/w3c/browser-specs/commit/6f77ab13508a5f6694f61c16b26c96e78014a250)
- Add first README and w3c.json file [`0e905d2`](https://github.com/w3c/browser-specs/commit/0e905d2686622aaee262e1aff7cd2845d2d7d240)
- Adjust workflow names [`7766efb`](https://github.com/w3c/browser-specs/commit/7766efb990464d599bcc30c060d6ef60b8403753)
- Remove group field from w3c.json [`c62bb96`](https://github.com/w3c/browser-specs/commit/c62bb96b6280a3eb20e3a129a2afba7c215c1d79)
- Ignore git commit exit code in fetch info workflow [`514687e`](https://github.com/w3c/browser-specs/commit/514687e0b0c6b51359235b6cffd8f8a9fc0640ba)

## Credits

Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
107 changes: 107 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
},
"devDependencies": {
"ajv": "^6.11.0",
"auto-changelog": "^1.16.4",
"mocha": "^7.0.0",
"release-it": "^13.5.1"
}
Expand Down