Skip to content

wooga/atlas-github

Repository files navigation

atlas-github

Gradle Plugin ID Build Status Coveralls Status Apache 2.0 GitHub tag GitHub release

This plugin provides tasks and conventions to publish artifacts to github with the help of github-api.kohsuke.org.

Applying the plugin

build.gradle

plugins {
    id 'net.wooga.github' version '1.2.0'
}

Usage

build.gradle

plugins {
    id "net.wooga.github" version "1.2.0"
}

github {
    userName = "wooga"
    password = "a password."
    token = "a github access token"
    repositoryName "wooga/atlas-github"
    baseUrl = null
}

githubPublish {
    userName = "wooga"
    password = "a password."
    token = "a github access token"
    repositoryName = "wooga/atlas-github"
    baseUrl = null
    targetCommitish = "master"
    tagName = project.version
    releaseName = project.version
    body = null
    prerelease = false
    draft = false

    //copySpec values
    from() {
        into
    }
}

Documentation

Gradle and Java Compatibility

Built with Oracle JDK7 Tested with Oracle JDK8

Gradle Version Works
< 5.0 no
5.0 yes
5.1 yes
5.2 yes
5.3 yes
5.4 yes
5.5 yes
5.6 yes
5.6 yes
6.0 yes
6.1 yes
6.2 yes
6.3 yes
6.4 yes
6.5 yes
6.6 yes
6.6 yes
6.7 yes
6.8 yes
6.9 yes
7.0 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.