latest.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "inspectVersion": {
      "type": "boolean",
      "description": "If set, Fork-Version will print the current version and exit."
    },
    "files": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of the files to be updated."
    },
    "glob": {
      "type": "string",
      "description": "Glob pattern to match files to be updated."
    },
    "path": {
      "type": "string",
      "description": "The path Fork-Version will run from. Defaults to \"process.cwd()\"."
    },
    "changelog": {
      "type": "string",
      "description": "Name of the changelog file. Defaults to \"CHANGELOG.md\"."
    },
    "header": {
      "type": "string",
      "description": "The header text for the changelog."
    },
    "tagPrefix": {
      "type": "string",
      "description": "Specify a prefix for the created tag. Defaults to \"v\"."
    },
    "preRelease": {
      "type": [
        "string",
        "boolean"
      ],
      "description": "Make a pre-release with optional label if given value is a string."
    },
    "currentVersion": {
      "type": "string",
      "description": "If set, Fork-Version will use this version instead of trying to determine one."
    },
    "nextVersion": {
      "type": "string",
      "description": "If set, Fork-Version will attempt to update to this version, instead of incrementing using \"conventional-commit\"."
    },
    "releaseAs": {
      "type": "string",
      "enum": [
        "major",
        "minor",
        "patch"
      ],
      "description": "Release as increments the version by the specified level. Overrides the default behaviour of \"conventional-commit\"."
    },
    "allowMultipleVersions": {
      "type": "boolean",
      "description": "Don't throw an error if multiple versions are found in the given files."
    },
    "commitAll": {
      "type": "boolean",
      "description": "Commit all changes, not just files updated by Fork-Version."
    },
    "changelogAll": {
      "type": "boolean",
      "description": "If this flag is set, all default commit types will be added to the changelog, not just `feat` and `fix`."
    },
    "debug": {
      "type": "boolean",
      "description": "Output debug information."
    },
    "dryRun": {
      "type": "boolean",
      "description": "No output will be written to disk or committed."
    },
    "silent": {
      "type": "boolean",
      "description": "Run without logging to the terminal."
    },
    "gitTagFallback": {
      "type": "boolean",
      "description": "If unable to find a version in the given files, fallback and attempt to use the latest git tag. Defaults to true."
    },
    "sign": {
      "type": "boolean",
      "description": "If true, git will sign the commit with the systems GPG key."
    },
    "verify": {
      "type": "boolean",
      "description": "If true, git will run user defined git hooks before committing."
    },
    "skipBump": {
      "type": "boolean",
      "description": "Skip the bump step."
    },
    "skipChangelog": {
      "type": "boolean",
      "description": "Skip the changelog step."
    },
    "skipCommit": {
      "type": "boolean",
      "description": "Skip the commit step."
    },
    "skipTag": {
      "type": "boolean",
      "description": "Skip the tag step."
    },
    "changelogPresetConfig": {
      "type": "object",
      "properties": {
        "types": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "description": "The type of commit message, such as \"feat\", \"fix\", \"chore\"."
              },
              "scope": {
                "type": "string",
                "description": "The scope of the commit message."
              },
              "section": {
                "type": "string",
                "description": "The section of the `CHANGELOG` the commit should show up in."
              },
              "hidden": {
                "type": "boolean",
                "description": "Should show in the generated changelog message?"
              }
            },
            "required": [
              "type"
            ],
            "additionalProperties": false
          },
          "description": "List of explicitly supported commit message types."
        },
        "commitUrlFormat": {
          "type": "string",
          "description": "A URL representing a specific commit at a hash."
        },
        "compareUrlFormat": {
          "type": "string",
          "description": "A URL representing the comparison between two git SHAs."
        },
        "issueUrlFormat": {
          "type": "string",
          "description": "A URL representing the issue format."
        },
        "userUrlFormat": {
          "type": "string",
          "description": "A URL representing a user's profile on GitHub, Gitlab, etc."
        },
        "releaseCommitMessageFormat": {
          "type": "string",
          "description": "A string to be used to format the auto-generated release commit message."
        },
        "issuePrefixes": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "List of prefixes used to detect references to issues."
        }
      },
      "additionalProperties": false,
      "description": "Override the default \"conventional-changelog-conventionalcommits\" preset configuration."
    },
    "releaseMessageSuffix": {
      "type": "string",
      "description": "Add a suffix to the release commit message."
    }
  }
}