Skip to content

Commit 1d15c9b

Browse files
committed
docs: add release instructions
1 parent 7de422c commit 1d15c9b

File tree

5 files changed

+2306
-200
lines changed

5 files changed

+2306
-200
lines changed

.versionrc.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"types": [
3+
{ "type": "feat", "section": "Features" },
4+
{ "type": "fix", "section": "Fixes" },
5+
{ "type": "chore", "section": "Chores" },
6+
{ "type": "chore(deps)", "section": "Dependency updates" },
7+
{ "type": "docs", "section": "Documentation" },
8+
{ "type": "style", "section": "Styling" },
9+
{ "type": "refactor", "section": "Refactors" },
10+
{ "type": "perf", "section": "Performance" },
11+
{ "type": "test", "section": "Testing" }
12+
],
13+
"header": "<!-- markdownlint-disable MD013 -->\n# Changelog\n\nAll notable changes to this project will be documented in this file.",
14+
"releaseCommitMessageFormat": "chore(release): Release version {{currentTag}} of the npm package"
15+
}

CHANGELOG.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,23 @@
1-
TODO
1+
# ODRL Evaluator release notes
2+
3+
## [0.4.0](https://github.com/SolidLabResearch/ODRL-Evaluator/compare/v0.3.0...v0.4.0)
4+
5+
6+
### Features
7+
8+
* create dedicated Atomizer class and add roadmap for atomization feature ([5f5bad6](https://github.com/SolidLabResearch/ODRL-Evaluator/commit/5f5bad6bae8863d6a05b425a9af82c8a4e0d0484))
9+
* create ODRL Evaluator that natively deals with Compact Rules + test ([05cfa15](https://github.com/SolidLabResearch/ODRL-Evaluator/commit/05cfa15b2f9bebeb44ec0c5a984016c24b253890))
10+
* introduce tests ([46729fd](https://github.com/SolidLabResearch/ODRL-Evaluator/commit/46729fd837687b6a9d383f5a42ab44b55b2e8570))
11+
* test2 now contains full algorithm ([bba88da](https://github.com/SolidLabResearch/ODRL-Evaluator/commit/bba88da8630a4b38dbaae0203454cfe553b3b348))
12+
13+
14+
### Fixes
15+
16+
* make sure tests run online by relying on eyeJs ([1fdd36c](https://github.com/SolidLabResearch/ODRL-Evaluator/commit/1fdd36c8346c7f201914465dc73f7f6c0a1633cb))
17+
18+
19+
### Documentation
20+
21+
* add citation instructions to ODRL Evaluator ([b8ef6bd](https://github.com/SolidLabResearch/ODRL-Evaluator/commit/b8ef6bd6680453e490efe1db439d891afb0792e1))
22+
* add release notes and bump version to 0.4.0 ([61478db](https://github.com/SolidLabResearch/ODRL-Evaluator/commit/61478db33243712b5a8d0091bc142b4b8a7199cc))
23+
* update Release notes and Atomization documentation ([867c08f](https://github.com/SolidLabResearch/ODRL-Evaluator/commit/867c08fe1d28ed32d84c9adec2a5fd571b522b79))

documentation/release.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Releasing a new version
2+
3+
This is only relevant if you are a developer with push access responsible for doing a new release.
4+
5+
Steps to follow:
6+
- Verify that the `RELEASE_NOTES.md` are correct.
7+
- Create release notes and tags: `npx commit-and-tag-version -r major/minor/patch`
8+
- Updates the package.json, and generates the new entries in CHANGELOG.md. Commits with chore(release): Release version vx.y.z of the npm package
9+
- Optionally run `npx commit-and-tag-version -r major/minor/patch --dry-run` to preview the commands that will be run and the changes to CHANGELOG.md.
10+
- Do a GitHub release
11+
- npm release: `npm run release`
12+
- potentially upgrade dependent repositories
13+
- ODRL Test Suite at https://github.com/SolidLabResearch/ODRL-Test-Suite
14+
- FORCE demo at https://github.com/woutslabbinck/ODRL-Evaluator-Demo
15+
- User-Access Server at https://github.com/SolidLabResearch/user-managed-access

0 commit comments

Comments
 (0)