Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wooga/atlas-github
Gradle plugin to publish artifacts to github
https://github.com/wooga/atlas-github
atlas github gradle publishing wooga
Last synced: about 1 month ago
JSON representation
Gradle plugin to publish artifacts to github
- Host: GitHub
- URL: https://github.com/wooga/atlas-github
- Owner: wooga
- License: apache-2.0
- Created: 2017-06-28T14:46:49.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-06-26T15:53:59.000Z (over 1 year ago)
- Last Synced: 2023-06-26T20:07:52.129Z (over 1 year ago)
- Topics: atlas, github, gradle, publishing, wooga
- Language: Groovy
- Homepage: https://wooga.github.io/atlas-github/
- Size: 512 KB
- Stars: 1
- Watchers: 38
- Forks: 3
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
atlas-github
============
[](https://plugins.gradle.org/plugin/net.wooga.github)
[](https://travis-ci.org/wooga/atlas-github)
[](https://coveralls.io/github/wooga/atlas-github?branch=master)
[](https://raw.githubusercontent.com/wooga/atlas-github/master/LICENSE)
[]()
[]()
This plugin provides tasks and conventions to publish artifacts to github with the help of [github-api.kohsuke.org][github-api].
# Applying the plugin
**build.gradle**
```groovy
plugins {
id 'net.wooga.github' version '1.2.0'
}
```
Usage
=====
**build.gradle**
```groovy
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
=============
- [API docs](https://wooga.github.io/atlas-github/docs/api/)
- [Tasks](docs/Tasks.md)
- [Release Notes](RELEASE_NOTES.md)
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](docs/Code-of-conduct.md)
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
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.
[github]: https://github.com
[github-env-auth]: http://github-api.kohsuke.org/apidocs/org/kohsuke/github/GitHubBuilder.html#fromEnvironment--
[github-cred-auth]: http://github-api.kohsuke.org/apidocs/org/kohsuke/github/GitHubBuilder.html#fromCredentials--
[yes]: https://resources.atlas.wooga.com/icons/icon_check.svg "yes"
[no]: https://resources.atlas.wooga.com/icons/icon_uncheck.svg "no"
[github-api]: http://github-api.kohsuke.org/source-repository.html
[copy-spec]: https://docs.gradle.org/3.4/javadoc/org/gradle/api/file/CopySpec.html
[copy-spec-into]: https://docs.gradle.org/3.4/javadoc/org/gradle/api/file/CopySpec.html#into(java.lang.Object)
[copy-destinationDir]: https://docs.gradle.org/current/dsl/org.gradle.api.tasks.Copy.html#org.gradle.api.tasks.Copy:destinationDir
[github-oauth-scopes]: https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/