Repository navigation
Releasing
Versions follow Semantic Versioning and every release is listed in the changelog.
| Change | Bump |
|---|---|
| Bug fixes only | patch (1.1.0 to 1.1.1) |
| New tools or features, nothing breaks | minor (1.1.0 to 1.2.0) |
| Something users or integrations rely on changes | major (1.1.0 to 2.0.0) |
-
Add a
## [x.y.z] - YYYY-MM-DDsection toCHANGELOG.md. Move entries out ofUnreleased. -
Set the same version in
package.json. -
Commit:
git commit -s -m "Release vx.y.z: bump version and update changelog". -
Create a signed annotated tag and push everything:
git tag -s vx.y.z -m "Mools x.y.z: short summary" git push origin master --tags
The Release workflow:
- checks that the tag matches
package.jsonand that the changelog has a section for it, - runs the tests and the build,
- attaches the built site as a
.tar.gz, - publishes the GitHub release with the changelog section as its notes, marked as a pre-release for versions below 1.0.0 or tags with a suffix such as
-rc.1.
The Deploy workflow publishes the site to GitHub Pages on every push to master, tagged or not.
The repository owner has GitHub's vigilant mode on, so unsigned tags show as "Unverified". Always use git tag -s. The repository sets tag.gpgsign true so this happens by default.
Deleting and re-creating a tag is possible but disruptive for anyone who fetched it. Prefer a new patch version.
Mools (Maling-IT Online Tools) is open source under the MIT license. Found a mistake on a wiki page? Edit it, or open an issue.
The project
Using Mools
Building Mools