atlas-releaseNotesGenerator

Github Release Notes Generator plugin for Gradle


Project maintained by wooga

atlas-releaseNotesGenerator

Wooga Internal Build Status Coveralls Status Apache 2.0 GitHub tag GitHub release

Applying the plugin

build.gradle

plugins {
    id 'net.wooga.releaseNotesGenerator' version '1.1.0'
}

Documentation

Gradle and Java Compatibility

Built with Oracle JDK7 Tested with Oracle JDK8

Gradle Version Works
< 3.0 no
3.0 yes
3.1 yes
3.2 yes
3.3 yes
3.4 yes
3.5 yes
3.5.1 yes
4.0 yes
4.1 yes
4.2 yes
4.3 yes
4.4 yes
4.5 yes
4.6 yes
4.6 yes
4.7 yes
4.8 yes
4.9 yes
4.10 yes

Development

Running the tests

The integration tests will access github with a botUser which credentials needs to be provided via environment variables.

Name Description
ATLAS_GITHUB_INTEGRATION_USER The username for of the BotUser. The name will also be used for the test repository.
ATLAS_GITHUB_INTEGRATION_PASSWORD A password for the gihub user or acces token.

If the value of ATLAS_GITHUB_INTEGRATION_PASSWORD is a access token, it needs the scopes: delete_repo, repo see [github-oauth-scopes] for more information.

Code of Conduct

LICENSE

Copyright 2017 Wooga GmbH

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.