Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 1.72 KB

README.md

File metadata and controls

50 lines (35 loc) · 1.72 KB
Raw

Presidium JSON Schema

A Golang tool for importing your JSON Schema spec into Presidium documentation.

Usage:
  presidium-json-schema convert [path] [flags]

Flags:
  -d, --destination string   the output directory (default ".")
  -e, --extension string     the schema extension (default "*.schema.json")
  -o, --ordered              preserve the schema order (defaults to alphabetical)
  -p, --orderedfilepath      preserve the schema order (defaults to alphabetical) by appending a digit to the filename prefix
  -c, --clean                removes the output directory before generating output files, negative by default
  -w, --walk                 walk through sub-directories

To convert a file you simply:

presidium-json-schema convert <PATH_TO_SCHEMA_DIR> -d <THE_DESTINATION_DIR>

Releasing a new version

This project uses GoReleaser to automate the release process. When you push a new tag to the repository, GoReleaser will create a new release with the artifacts for the supported platforms and publish it to the Span Homebrew tap.

The version number should follow the Semantic Versioning specification.

git tag -a vX.Y.Z -m "Release version X.Y.Z"
git push origin vX.Y.Z

Once a release is published, you can install the new version or upgrade an existing installation using Homebrew.

To install the latest version:

brew tap SPANDigital/homebrew-tap https://github.com/SPANDigital/homebrew-tap.git
brew install presidium-json-schema

To upgrade an existing installation:

brew upgrade presidium-json-schema