Skip to content

Commit

Permalink
Kick unused dependencies, rest of docs bits
Browse files Browse the repository at this point in the history
  • Loading branch information
dead-claudia committed Sep 25, 2024
1 parent 61ad84c commit 33e1562
Show file tree
Hide file tree
Showing 4 changed files with 101 additions and 2,657 deletions.
3 changes: 0 additions & 3 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,3 @@ tests/
# from changes to it in patch releases. Let's force people to finally stop using
# them.
/test-utils/

# Exclude archive of previous docs (see #2552)
/archive/
31 changes: 1 addition & 30 deletions docs/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,41 +26,12 @@ If you do not have permissions, the maintainer will set the label on your behalf

## Changelog

There are two changelogs in the Mithril.js project

- `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.
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.

## For maintainers

Whenever a new feature branch is opened, a reviewing maintainer should add the correct semver label to their PR (`major` | `minor` | `patch`). If no label is set, `patch` is assumed.

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/
Loading

0 comments on commit 33e1562

Please sign in to comment.