Skip to main content
Warning: You are using the test version of PyPI. This is a pre-production deployment of Warehouse. Changes made here affect the production instance of TestPyPI (testpypi.python.org).
Help us improve Python packaging - Donate today!

Release notes generator package

Project Description

Just Release Notes

The tool provides a way of customizing the process of generating the Release Notes based on:

  • Issue tracking identifiers in commit messages
  • Tags on commit
  • Release artifacts repository

Running the tool

Usage

To run the tool, call:

& just_release notes -c <config.json>

Configuration

Configuration file is in flux. For now it is a json looking something like this:

{
   "pathToSave" : <output path>,

    "packages" : {
        <package name> : {
            "Issues" : {
                "Provider" : <issues provider>,
                "HtmlUrl" : ...,
                "Authorization" : ...,
                "Url" : ...,
                "WebImagesPath" : ...
                "TicketRegex" : ...
            },
            "Releases" : {
                "Provider" : <releases provider>,
                "Repository" : ...,
                "ArtifactUri" : ...,
                "StorageUrl" : ...
            },
            "Source" : {
                "Provider" : <source provider>
                "RepositoryUrl" : ...
                "Remote" : ...
            },
            "ReleaseNotesWriter" : <notes writer>
        }
    }
}

where

notes writer is either:

  • HtmlWriter
  • MarkdownWriter

releases provider is either:

  • Artifactory
  • GitHubReleases

issues provider is either:

  • JiraIssues
  • GitHubIssues

source provider is currently only:

  • GitRepo

You can also use environment variables using the following syntax:

{
    ...
    "key" : "aaa ENV[xxx] bbb"
    ...
}

In the above example, ENV[xxx] will be replaced with the value of ‘xxx’ variable

Release History

Release History

This version
History Node

0.1.0

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting