https://github.com/wooga/atlas-plugins
a Base gradle plugin for atlas gradle plugin development
https://github.com/wooga/atlas-plugins
atlas gradle internal plugins wooga
Last synced: 6 months ago
JSON representation
a Base gradle plugin for atlas gradle plugin development
- Host: GitHub
- URL: https://github.com/wooga/atlas-plugins
- Owner: wooga
- License: apache-2.0
- Created: 2017-11-21T15:22:31.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-08-18T14:13:53.000Z (almost 2 years ago)
- Last Synced: 2023-08-18T15:40:56.510Z (almost 2 years ago)
- Topics: atlas, gradle, internal, plugins, wooga
- Language: Groovy
- Homepage: https://wooga.github.io/atlas-plugins/
- Size: 391 KB
- Stars: 0
- Watchers: 38
- Forks: 2
- Open Issues: 8
-
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-plugins
=============
[](https://plugins.gradle.org/plugin/net.wooga.plugins)
[](https://raw.githubusercontent.com/wooga/atlas-plugins/master/LICENSE)
[]()
[]()
Plugin to establish conventions for a atlas gradle plugins. This plugin is used to help setup our other plugins.
Usage
=====
Public Plugins
--------------
**build.gradle**
```groovy
plugins {
id "net.wooga.plugins" version "3.2.0"
}
```
It applies the following plugins:
* 'groovy'
* 'idea'
* 'publish'
* 'plugin-publish'
* 'nebular.release'
* 'jacoco'
* 'net.wooga.github'
* 'maven-publish'
Private Plugins
---------------
The private plugin conventions are the base for the normal plugin. The main difference is the lack of
any publishing settings.
**build.gradle**
```groovy
plugins {
id "net.wooga.plugins-private" version "3.2.0"
}
```
Local Plugins
-------------
The local plugin is for cases when plugins are developed and used inside another project. With this setup
it is easier to pull out a plugin later to use it for multiple projects either as an private plugin
or public plugin
**build.gradle**
```groovy
plugins {
id "net.wooga.plugins-local" version "3.2.0"
}
```
### Testing/Development
The resulting project structure is prepared as a normal groovy gradle plugin. Additional to the normal `test` task the plugin also adds a `integrationTest` task with code coverage and reporting. As test framework `Spock` will be added to the classpath. The jocoo plugin is used for code coverage. The integration test results are merged with the unit test results. All our plugins push the coverage report to coveralls. The coveralls plugin is connected to jacoco and only needs the `COVERALLS_TOKEN` in the environment. The plugin will also generate an idea project with the integration tests configured as seperate module.
### Publish/Release
The project uses [Nebular Release](https://github.com/nebula-plugins/nebula-release-plugin) for the release and publish cycle. The tasks `final` and `candidate` will publish the plugin to the gradle plugins repository with the help of the `plugin-publish` plugin and create a formal gitub release with the `net.wooga.github` plugin. The `snapshot` task will only publish to the local maven repository.
Documentation
=============
- [API docs](https://wooga.github.io/atlas-plugins/docs/api/)
- [Release Notes](RELEASE_NOTES.md)
Gradle and Java Compatibility
=============================
Tested with openJDK8
| 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
===========
[Code of Conduct](docs/Code-of-conduct.md)
LICENSE
=======
Copyright 2017-2021 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.