Skip to content

Commit

Permalink
update docs and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
mpern committed Jun 15, 2022
1 parent edcef4f commit f73c2e8
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 22 deletions.
34 changes: 33 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,37 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

TBD

## [3.7.0] 2022-06-15

### Deprecated

- `sap.commerce.ccv1.package` - CCv1 is sunset. The packaging plugin will be removed in the next release

### Added

- Commerce plugin: [Lazy configuration] with fallback for ant properties ([$32])
- Commerce plugin: `HybrisAntTaks` support for 2205
- CCv2 Plugin, manifest validation: Add support for SAP Commerce 2105 and
Integration Extension Pack 2108 ([#38])
- CCv2 Plugin, manifest validation: Add support for SAP Commerce 2205 and
Integration Extension Pack 2205

### Fixed

- Windows compatibility ([#34])

Thank you [@tklostermannNSD] for adding the 2105 / 2108 compatibility check!

Special shout out to [@aepfli] for not only adding lazy configuration to `HybrisAntTas` and improving
the Windows compatibility, but for also adding the much-needed OS compatibility check to our
GH Actions flow.

[#32]: https://github.com/SAP/commerce-gradle-plugin/pull/32
[Lazy configuration]: https://docs.gradle.org/current/userguide/lazy_configuration.html
[#38]: https://github.com/SAP/commerce-gradle-plugin/pull/38
[@aepfli]: https://github.com/aepfli
[@tklostermannNSD]: https://github.com/tklostermannNSD

## [3.6.0] 2021-06-25

### Changed
Expand Down Expand Up @@ -309,7 +340,8 @@ Shout out to [@corneleberle] for providing the fix.

:tada: Initial release :tada:

[Unreleased]: https://github.com/SAP/commerce-gradle-plugin/compare/v3.6.0...HEAD
[Unreleased]: https://github.com/SAP/commerce-gradle-plugin/compare/v3.7.0...HEAD
[3.7.0]: https://github.com/SAP/commerce-gradle-plugin/compare/v3.6.0...v3.7.0
[3.6.0]: https://github.com/SAP/commerce-gradle-plugin/compare/v3.5.0...v3.6.0
[3.5.0]: https://github.com/SAP/commerce-gradle-plugin/compare/v3.4.0...v3.5.0
[3.4.0]: https://github.com/SAP/commerce-gradle-plugin/compare/v3.3.0...v3.4.0
Expand Down
31 changes: 10 additions & 21 deletions docs/Plugin-sap.commerce.build.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
# Plugin `sap.commerce.build`

The goal for this plugin is to automate the most common steps when setting up a SAP Commerce development environment and
allows you to call the platform ant build as a Gradle task (in your script, or from the command line).

It also allows you to automate the download of the distribution zip files from the SAP Support Portal.
The goal for this plugin is to automate the most common steps when setting up a SAP Commerce development
environment and allows you to call the platform ant build as a Gradle task (in your script, or from
the command line).

## Configuration

The following example shows the full DSL (Domain Specific Language) with all default options and the dependencies the
plugin pre-configures.
The following example shows the full Domain Specific Language (DSL) with all default options and
pre-configured dependencies.

```gradle
hybris {
//SAP Commerce version to use
version = "2011.4"
version = "2205.0"
//What files should be deleted when cleaning up the platform?
cleanGlob = "glob:**hybris/bin/{ext-**,platform**}"
Expand Down Expand Up @@ -105,6 +104,9 @@ This task type allows you to define a hybris ant target as Gradle task.

Under the hood it's a pre-configured `JavaExec` task

**Added in 3.7.0:** Lazy configuration of `antProperties` plus `fallbackAntProperties` for fallbacks
if something is not configured during a particular Gradle run.

#### Example:

```gradle
Expand All @@ -122,24 +124,11 @@ task unitTests(type: mpern.sap.commerce.build.tasks.HybrisAntTask) {
}
```


### ~~`mpern.sap.commerce.build.tasks.SupportPortalDownload`~~

**Deprecated with v2.1.1; Removed with v3.0.0; Check the [FAQ](FAQ.md)**

Downloads hybris commerce files from the SAP Support Portal.

| Parameter | Description |
| ------------- | ------------- |
| `supportPortalUrl` | URL of the file in the Support Portal (The same URL that opens when you click on the link on the Hybris Commerce Release Page) |
| `username` | S/I/D-User |
| `password` | Password |
| `targetFile` | Where the file is downloaded to |
| `md5Hash` | Expected MD5-hash of the file (used to perform up-to-date checks). You can find the hash in the Support Portal via Related Info -> Content Info |
| `sha256Sum` | Expected SHA-256 hash of the file. You need to specify either the `md5Hash` or the `sha256Sum` |

The plugin also makes sure that all `SupportPortalDownload` tasks are executed before `bootstrapPlatform`, to avoid
dependency resolution issues when bootstrapping the platform after a fresh clone.

## Task Rules

For convenience, the plugin also defines task rule that allows you to call any ant target directly from the Gradle
Expand Down

0 comments on commit f73c2e8

Please sign in to comment.