Skip to content
vshnPublic

About

Docker image containing an Asciidoc + Microsoft rules aware version of the `vale` tool

Topics

Resources

Stars

2 stars

Watchers

1 watching

Forks

Latest commit

 

History

391 Commits

Folders and files

Repository files navigation

Vale for VSHN

This project generates a ready-to-use installation of the vale, a "syntax-aware linter for prose built with speed and extensibility in mind."

This image is geared specifically to verify Asciidoc files using the Microsoft, Openly and built-in Vale text style rules. It contains:

Usage

Use it as follows, for example on an Antora project root, to verify all Asciidoc files in that folder:

podman run --rm --volume "${PWD}"/src/modules/ROOT/pages:/pages --workdir /pages ghcr.io/vshn/vale:2.15.5 --minAlertLevel=error .

Release

Every merge to master is released. The workflow builds the image, runs it on each platform it publishes, and only then tags it with the vale version from the Dockerfile and moves latest. When that version has been released already and only the image around vale changed, it appends .1, .2 and so on. The matching git tag is created too, unsigned.

Consumers pin a version, so anything that stays on master reaches nobody.

tag-release.sh is still there to cut a release by hand, and unlike the workflow it signs the tag:

./tag-release.sh

About

Docker image containing an Asciidoc + Microsoft rules aware version of the `vale` tool

Topics

Resources

Stars

2 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages