Kick unused dependencies, rest of docs bits
This commit is contained in:
parent
61ad84c1d9
commit
33e1562fc1
4 changed files with 1 additions and 2557 deletions
|
|
@ -20,6 +20,3 @@ tests/
|
||||||
# from changes to it in patch releases. Let's force people to finally stop using
|
# from changes to it in patch releases. Let's force people to finally stop using
|
||||||
# them.
|
# them.
|
||||||
/test-utils/
|
/test-utils/
|
||||||
|
|
||||||
# Exclude archive of previous docs (see #2552)
|
|
||||||
/archive/
|
|
||||||
|
|
|
||||||
|
|
@ -26,12 +26,7 @@ If you do not have permissions, the maintainer will set the label on your behalf
|
||||||
|
|
||||||
## Changelog
|
## Changelog
|
||||||
|
|
||||||
There are two changelogs in the Mithril.js project
|
Currently, `docs/recent-changes.md` holds an automatically prepended log of changes, managed by pr-release. Ideally, I want to get rid of this and just have pr-release somehow push to https://github.com/MithrilJS/docs automatically, but that may take some work.
|
||||||
|
|
||||||
- `docs/changelog.md` a hand written curated reflection of changes to the codebase
|
|
||||||
- `docs/release.md` an automatically prepended log of changes, managed by pr-release
|
|
||||||
|
|
||||||
In future we may collapse these into a single file, the separation is due to the fact the `changelog.md` predates the `release.md` file.
|
|
||||||
|
|
||||||
## For maintainers
|
## For maintainers
|
||||||
|
|
||||||
|
|
@ -39,28 +34,4 @@ Whenever a new feature branch is opened, a reviewing maintainer should add the c
|
||||||
|
|
||||||
If a `major` or `minor` feature branch is merged but no labels were set, you can still go back and edit the semver labels. On label change the release pr will automatically be regenerated and will recalculate the semver version.
|
If a `major` or `minor` feature branch is merged but no labels were set, you can still go back and edit the semver labels. On label change the release pr will automatically be regenerated and will recalculate the semver version.
|
||||||
|
|
||||||
## Updating mithril.js.org
|
|
||||||
|
|
||||||
Fixes to documentation can land whenever, updates to the site are built and published via `scripts/update-docs.js`.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# These steps assume that MithrilJS/mithril.js is a git remote named "mithriljs"
|
|
||||||
|
|
||||||
# Ensure your next branch is up to date
|
|
||||||
$ git checkout next
|
|
||||||
$ git pull mithriljs next
|
|
||||||
|
|
||||||
# Splat the docs folder from next onto release
|
|
||||||
$ git checkout release
|
|
||||||
$ git checkout next -- ./docs
|
|
||||||
|
|
||||||
# Manually ensure that no new feature docs were added
|
|
||||||
|
|
||||||
$ node scripts/update-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
After the docs build completes, the updated docs should appear on https://mithril.js.org in a few minutes.
|
|
||||||
|
|
||||||
**Note:** When updating the stable version with a release candidate out, ***make sure to update the index + navigation to point to the new stable version!!!***
|
|
||||||
|
|
||||||
[pr-release]: https://pr-release.org/
|
[pr-release]: https://pr-release.org/
|
||||||
|
|
|
||||||
2502
package-lock.json
generated
2502
package-lock.json
generated
File diff suppressed because it is too large
Load diff
22
package.json
22
package.json
|
|
@ -8,20 +8,15 @@
|
||||||
"jsdelivr": "mithril.min.js",
|
"jsdelivr": "mithril.min.js",
|
||||||
"repository": "github:MithrilJS/mithril.js",
|
"repository": "github:MithrilJS/mithril.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"precommit": "lint-staged",
|
|
||||||
"watch": "run-p watch:**",
|
"watch": "run-p watch:**",
|
||||||
"watch:js": "node scripts/bundler browser.js -output mithril.js -watch",
|
"watch:js": "node scripts/bundler browser.js -output mithril.js -watch",
|
||||||
"watch:docs": "node scripts/generate-docs --watch",
|
|
||||||
"watch:docs-lint": "node scripts/lint-docs --watch",
|
|
||||||
"build": "run-p build:browser build:min build:stream-min",
|
"build": "run-p build:browser build:min build:stream-min",
|
||||||
"build:browser": "node scripts/bundler browser.js -output mithril.js",
|
"build:browser": "node scripts/bundler browser.js -output mithril.js",
|
||||||
"build:docs": "node scripts/generate-docs",
|
|
||||||
"build:min": "node scripts/bundler browser.js -output mithril.min.js -minify -save",
|
"build:min": "node scripts/bundler browser.js -output mithril.min.js -minify -save",
|
||||||
"build:stream-min": "node scripts/minify-stream",
|
"build:stream-min": "node scripts/minify-stream",
|
||||||
"cleanup:lint": "rimraf .eslintcache",
|
"cleanup:lint": "rimraf .eslintcache",
|
||||||
"lint": "run-s -cn lint:**",
|
"lint": "run-s -cn lint:**",
|
||||||
"lint:js": "eslint . --cache",
|
"lint:js": "eslint . --cache",
|
||||||
"lint:docs": "node scripts/lint-docs",
|
|
||||||
"perf": "node performance/test-perf.js",
|
"perf": "node performance/test-perf.js",
|
||||||
"pretest": "npm run lint",
|
"pretest": "npm run lint",
|
||||||
"test": "run-s test:js",
|
"test": "run-s test:js",
|
||||||
|
|
@ -29,31 +24,14 @@
|
||||||
"cover": "istanbul cover --print both ospec"
|
"cover": "istanbul cover --print both ospec"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@alrra/travis-scripts": "^3.0.1",
|
|
||||||
"@babel/parser": "^7.7.5",
|
|
||||||
"benchmark": "^2.1.4",
|
"benchmark": "^2.1.4",
|
||||||
"chokidar": "^3.2.1",
|
"chokidar": "^3.2.1",
|
||||||
"escape-string-regexp": "^2.0.0",
|
|
||||||
"eslint": "^8.9.0",
|
"eslint": "^8.9.0",
|
||||||
"gh-pages": "^6.1.1",
|
|
||||||
"glob": "^11.0.0",
|
"glob": "^11.0.0",
|
||||||
"html-minifier-terser": "^7.2.0",
|
|
||||||
"istanbul": "^0.4.5",
|
"istanbul": "^0.4.5",
|
||||||
"lint-staged": "^15.2.10",
|
|
||||||
"locater": "^1.3.0",
|
|
||||||
"marked": "^14.1.0",
|
|
||||||
"minimist": "^1.2.0",
|
|
||||||
"npm-run-all": "^4.1.5",
|
"npm-run-all": "^4.1.5",
|
||||||
"ospec": "4.2.1",
|
"ospec": "4.2.1",
|
||||||
"pinpoint": "^1.1.0",
|
|
||||||
"rimraf": "^6.0.1",
|
"rimraf": "^6.0.1",
|
||||||
"semver": "^6.3.0",
|
|
||||||
"terser": "^4.3.4"
|
"terser": "^4.3.4"
|
||||||
},
|
|
||||||
"lint-staged": {
|
|
||||||
"*.js": [
|
|
||||||
"eslint . --fix",
|
|
||||||
"git add"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue