Skip to content

Update documentation #136

@lasse-seivaag

Description

@lasse-seivaag

First of all, thank you to all who have contributed here, it is a good project.

The readme (and other documentation) seems to be out of date / missing some important parts.

  • We had issues with linking the CLI arguments to the .versionize configuration file
    • --project-name does not state that it expects a value (--project-name <PROJECT_NAME>)
  • Configuration file example is missing important properties which we needed to use
    • TagTemplate is not mentioned at all in readme
    • Could a full schema be part of the readme, or placed in source and linked to?

We had to dig through the source code to find the available options and correct usage.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions