Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SAP/commerce-gradle-plugin
Gradle plugins for the full development lifecycle of a SAP Commerce project
https://github.com/SAP/commerce-gradle-plugin
automation commerce commerce-cloud gradle-plugin hcs hybris hybris-commerce-suite sap sap-commerce sap-hybris
Last synced: 3 months ago
JSON representation
Gradle plugins for the full development lifecycle of a SAP Commerce project
- Host: GitHub
- URL: https://github.com/SAP/commerce-gradle-plugin
- Owner: SAP
- License: apache-2.0
- Created: 2018-06-21T10:06:56.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-06-06T15:37:08.000Z (5 months ago)
- Last Synced: 2024-06-06T17:34:22.963Z (5 months ago)
- Topics: automation, commerce, commerce-cloud, gradle-plugin, hcs, hybris, hybris-commerce-suite, sap, sap-commerce, sap-hybris
- Language: Java
- Homepage:
- Size: 2.05 MB
- Stars: 31
- Watchers: 8
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-sap-commerce - SAP Commerce Gradle Plugin - Gradle Plugin support SAP Commerce folder structure. (SAP Commerce Resources / GitHub)
README
# SAP Commerce Gradle Plugins 4.0.0
[](https://github.com/SAP/commerce-gradle-plugin/actions)
[](https://api.reuse.software/info/github.com/SAP/commerce-gradle-plugin)
Bootstrap, configure and build your SAP Commerce (Hybris) project using Gradle 5+.
> [!TIP]
> **For the user documentation, please check the [`/docs` folder](/docs)**
The plugins are published to https://plugins.gradle.org/.
| Published Plugin | Documentation | Description |
| --------------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| [`sap.commerce.build`][build] | [Documentation][build-doc] | Automates the developer setup and allows you to interact with the platform build using Gradle |
| [`sap.commerce.build.ccv2`][ccv2] | [Documentation][ccv2-doc] | Use `manifest.json` to configure and build your "SAP Commerce Cloud in the Public Cloud" (aka CCv2) project locally |
This project uses [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html)
## Getting Started
Here is how you get started with the plugins for your SAP Commerce project.
### Prerequisites
[Install Gradle](https://gradle.org/install/), in case you haven't yet.
### Examples
**Minimal Setup for CCv2 Manifest Validation**
1. ```cd /core-customize```
2. (optional, but highly recommended) Initialize the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html)
```shell
gradle wrapper
```
3. Add a minimal Gradle build script:\
`build.gradle.kts`
```kotlin
plugins {
id("sap.commerce.build.ccv2") version("4.0.0")
}
```
4. `./gradlew validateManifest`
**Development Setup**
*For a fully automated, best-practice CCv2 project setup, refer to [sap-commerce-tools/ccv2-project-template](https://github.com/sap-commerce-tools/ccv2-project-template)*
1. ```cd /core-customize```
2. (optional, but highly recommended) Initialize the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html)
```shell
gradle wrapper
```
3. Add Gradle build script \
```build.gradle.kts```
```kotlin
plugins {
id("sap.commerce.build") version("4.0.0")
id("sap.commerce.build.ccv2") version("4.0.0")
}
repositories {
//Please refer to the official Gradle documentation and the plugin documentation for additional
// information about dependency resolution.
// Option 1: Use a (custom) Maven repository to provide SAP Commerce artifacts for development
maven {
url = uri("https://custom.repo.com/maven")
}
// Option 2: Download all required files manually and put them in `dependencies` folder
// There are ways to automate the downloads from launchpad.support.sap.com, please check the FAQ.
// Make sure to rename the files accordingly (-.zip)
flatDir { dirs("dependencies") }
mavenCentral()
}
```
4. Enjoy things like:
- `./gradlew bootstrapPlatform` - download (if you use Maven) and set up the correct SAP Commerce zip, extension packs, cloud extension packs, ..., as defined in `manifest.json`
- `./gradlew installManifestAddons` - install all addons as defined in `manifest.json`
- `./gradlew yclean yall` - run `ant clean all` using Gradle. You can run any Ant target provided by SAP Commerce as `y`.
- `./gradlew validateManifest`- validate your manifest for common errors. Now with additional checks because
the full platform is available.
- `./gradlew cloudTests cloudWebTests`- run the tests defined in `manifest.json`
Don't forget to commit the Gradle Wrapper and your build script.
## Support
Please raise an [issue] in this GitHub project, following the guidelines outlined in [CONTRIBUTING.md]
## Contributing
Please refer to [CONTRIBUTING.md]
[CONTRIBUTING.md]: CONTRIBUTING.md
[issue]: https://github.com/SAP/commerce-gradle-plugin/issues
[build]: https://plugins.gradle.org/plugin/sap.commerce.build
[build-doc]: docs/Plugin-sap.commerce.build.md
[ccv2]: https://plugins.gradle.org/plugin/sap.commerce.build.ccv2
[ccv2-doc]: docs/Plugin-sap.commerce.build.ccv2.md
[tools]:https://github.com/sap-commerce-tools