conjur-oss-suite-release

module
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 17, 2020 License: Apache-2.0

README

conjur-oss-suite-release

Latest stable releases of the Conjur OSS suite

THIS REPO IS UNDER CONSTRUCTION, AND THERE ARE NO SUITE RELEASES AVAILABLE YET

For more info on the planned work, please see our design doc and monitor the github issues.

This repo's metrics:

Tests Test Coverage Maintainability

Usage

  • Edit the file suite.yml as needed
  • Run the CHANGELOG generator:
./parse-changelogs
  • Resulting changelog will be placed in CHANGELOG.md

Advanced usage

The CLI accepts the following arguments/parameters:

  -f string
        Repository YAML file to parse (default "suite.yml")
  -o string
        Output filename
  -p string
        GitHub API token. This can also be passed in as the 'GITHUB_TOKEN' environment variable. The flag takes precedence.
  -r string
        Directory of releases (containinng 'suite_<semver>.yml') files. Set this to empty string to skip suite version diffing. (default "releases")
  -t string
        Output type. Only accepts 'changelog', 'docs-release', 'release', and 'unreleased'. (default "changelog")
  -v string
        Version to embed in the changelog (default "Unreleased")

Development

We welcome contributions of all kinds. For instructions on how to get started and descriptions of our development workflows, please see our contributing guide.

License

This repository is licensed under Apache License 2.0 - see LICENSE for more details.

Directories

Path Synopsis
cmd
pkg
cli
log

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL