Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wttech/gradle-sling-plugin
Build rapidly Sling applications using Gradle Build System
https://github.com/wttech/gradle-sling-plugin
apache-sling composum gradle sling sling-instance vault
Last synced: about 1 month ago
JSON representation
Build rapidly Sling applications using Gradle Build System
- Host: GitHub
- URL: https://github.com/wttech/gradle-sling-plugin
- Owner: wttech
- License: apache-2.0
- Created: 2018-06-20T12:05:25.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-01-27T14:28:14.000Z (almost 4 years ago)
- Last Synced: 2023-03-12T05:02:12.645Z (almost 2 years ago)
- Topics: apache-sling, composum, gradle, sling, sling-instance, vault
- Language: Kotlin
- Homepage:
- Size: 18 MB
- Stars: 14
- Watchers: 13
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
[](https://gradleupdate.appspot.com/Cognifide/gradle-sling-plugin/status)
[](http://www.apache.org/licenses/)
# Gradle Sling Plugin
Currently there is no popular way to build applications for Sling using Gradle build system. This project contains brand new Gradle plugin to assemble Vault package and deploy it on instance(s).
Incremental build which takes seconds, not minutes. Developer who does not loose focus between build time gaps. Extend freely your build system directly in project.
Sling developer - it's time to meet Gradle! You liked or used plugin? Don't forget to **star this project** on GitHub :)
Check out [live demo](https://adapt.to/2018/en/schedule/a-better-developer-experience-for-sling-based-applications.html) presented on official **Sling adaptTo() 2018** conference.
## Table of contents
* [Documentation](#documentation)
* [Differences](#differences)
* [No queries](#no-queries)
* [No workflow manager](#no-workflow-manager)
* [No automatic node types synchronization](#no-automatic-node-types-synchronization)
* [Building](#building)
* [Contributing](#contributing)
* [License](#license)
## Documentation
This project is a **fork** of [Gradle AEM Plugin](https://github.com/wttech/gradle-aem-plugin).
Almost all of its concepts are applicable to pure Sling so that all of features of GAP 14.x.x are available in GSP.
The maintenance and synchronization of two separate plugins may be exhausting, so that any **volunteers** that will take care about this fork are appreciated.
Generally to keep documentation up to date and occasionally transfer code from GAP to GSP and vice versa.
For now, just consider mapping word **aem** to **sling** while reading GAP documentation to be able to start work on GSP.
This is also applicable to build script, for instance:
```groovy
sling {
// ...
}
```
Task names are not changed - are same as in Gradle AEM Plugin.
### Differences
There are few differences between GAP and GSP, that it is good to be aware.
#### No queries
Sling Plugin has no capabilities to perform queries as of query builder endpoints are available only on AEM. Simply instead of queries:
```kotlin
instance.sync { repository.node("/content").query { /* ... */ } }
```
Use traversing with filtering:
```kotlin
instance.sync { repository.node("/content").traverse().filter { subnode -> /* ... */ } }
```
### No workflow manager
Toggling workflows e.g for a time of deploying package is not available as of there are no such thing as workflows on pure Sling instance.
### No automatic node types synchronization
See:
## Building
1. Clone this project using command `git clone https://github.com/wttech/gradle-sling-plugin.git`
2. Enter cloned directory and simply run command: `gradlew`
3. To use built plugin:
* Add `mavenLocal()` to `repositories` section inside `pluginManagement` of *settings.gradle* file.
* Ensuring having correct version of plugin specified in *settings.gradle* file.
4. To debug built plugin:
* Append to build command parameters `--no-daemon -Dorg.gradle.debug=true`
* Run build, it will suspend, then connect remote at port 5005 by using IDE
* Build will proceed and stop at previously set up breakpoint.
## Contributing
Issues reported or pull requests created will be very appreciated.
1. Fork plugin source using a dedicated GitHub button.
2. Do code changes on a feature branch created from *develop* branch.
3. Create a pull request with a base of *develop* branch.
## License
**Gradle Sling Plugin** is licensed under the [Apache License, Version 2.0 (the "License")](https://www.apache.org/licenses/LICENSE-2.0.txt)