Commit Graph

51 Commits

Author SHA1 Message Date
Daz DeBoer ff9ae24c39 Add open-source 'basic' cache provider and revamp licensing documentation (#930)
## Summary

- **New `basic` cache provider**: Adds an open-source (MIT-licensed)
caching implementation built on `@actions/cache` as an alternative to
the proprietary Enhanced Caching. Users can opt in with `cache-provider:
basic` on both `setup-gradle` and `dependency-submission` actions.
- **Revamped licensing & distribution docs**: Replaces the verbose
licensing notice block (previously shown in README, docs, and logs) with
a friendlier callout and a new dedicated
[DISTRIBUTION.md](./DISTRIBUTION.md) covering component licensing, usage
tiers, data privacy ("Safe Harbor"), and opt-out instructions.
- **Improved messaging**: Enhanced Caching and Basic Caching each
display concise, informative log messages and job summary notes instead
of the previous wall-of-text license warning.
- **New integration tests**: Adds `integ-test-basic-cache-provider.yml`
workflow that seeds and verifies the basic cache provider across
platforms, plus unit tests for `BasicCacheService` and `getCacheService`
selection logic.
- **CI workflow reorganization**: Dependency-submission integration
tests extracted into their own reusable suite
(`suite-integ-test-dependency-submission.yml`); sample project tests
moved into the caching suite.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-02 21:36:01 -06:00
Leonard Brünings 9e6b5adc6e Add typing information for use by typesafegithub (#814)
Introduces type descriptor YAML files for GitHub
Actions in the repository, improving type safety and documentation for
action inputs and outputs. It also adds a new GitHub Actions workflow to
validate these typings automatically on pushes and pull requests. The
changes are grouped into the addition of type descriptor files for
various actions and the automation of their validation.

https://github.com/typesafegithub/github-actions-typing

**Type descriptor files for GitHub Actions:**

* Added `action-types.yml` files to `setup-gradle`,
`dependency-submission`, and `wrapper-validation` actions, specifying
input and output types for each action to improve type safety and
documentation.
[[1]](diffhunk://#diff-542de74831b6dc1954ff20a4c329b170053c82087ea7df742bd536156133f25bR1-R171)
[[2]](diffhunk://#diff-44708a3af3d0f3cfed1873f9b77d7e815c6c14e941fa3dd5ed08835a69d67855R1-R146)
[[3]](diffhunk://#diff-3fe1028d7aa5ee815c90fa580d4f62e646f0b9a4b7372f227fc131a56948ace0R1-R17)

**Automation and validation:**

* Introduced a new GitHub Actions workflow
`.github/workflows/ci-validate-typings.yml` to automatically validate
action typings on pushes to `main` and `release/**` branches, as well as
on pull requests. This uses the `github-actions-typing` action for
validation.
2026-03-23 12:06:12 -06:00
Zongle Wang 310f24cf39 Bump actions used in docs (#792) 2026-03-23 11:53:33 -06:00
Jerome Prinet 6f229686ee Upgrade gradle/actions to v5 2025-10-01 12:23:40 +02:00
amyu beb45655ae Upgrade to node 24 2025-09-15 01:37:28 +09:00
daz 245c8a24de Save dependency-graph file as workflow artifact
Diagnosing unexpected dependencies in the GitHub Dependency Graph can
be difficult. In order to aid with diagnosis, the `dependency-submission`
action will  now save each dependency-graph file as a workflow artifact.

If this is undesirable, the prior behaviour can be restored by explicitly setting
`dependency-graph: generate-and-submit`.

Fixes #519
2025-01-21 14:34:49 -07:00
daz add58192d1 Improve parameter description for 'cache-cleanup' 2024-08-05 10:54:56 -06:00
daz 895252588e Update docs for v4 release 2024-08-03 16:39:51 -06:00
daz b644be617f Enable wrapper validation by default
- Add 'allow-snapshot-wrappers' input parameter
- Default 'validate-wrappers' to 'true'

Fixes #12
2024-08-01 10:51:02 -06:00
daz 7bb45b1dbd Finish enabling cache-cleanup by default
- Add deprecation warning for `gradle-home-cache-cleanup`
- Change default for `dependency-submission` to `cache-cleanup: on-success`
- Update documentation for changed default
2024-07-21 14:19:54 -06:00
daz 7387edbbb3 Add more input parameters for dependency-graph generation
- dependency-graph-include-projects
- dependency-graph-exclude-projects
- dependency-graph include-configurations
- dependency-graph-exclude-configurations
2024-07-19 17:22:07 -06:00
daz 9e459adb11 Add 'dependency-graph-report-dir' input parameter 2024-07-19 17:21:10 -06:00
daz ded8009fcf Remove deprecated input parameters 2024-07-19 15:12:40 -06:00
daz 27dea2df09 Allow better control over cache-cleanup
Adds new 'cache-cleanup' parameter with 3 settings: 'never', 'on-success' and 'always'.
This gives users more control over whether cache cleanup should occur.

Fixes #71
2024-07-17 20:36:33 -06:00
Alexis Tual 500e0ee5b3 Add support for short-lived tokens (#224)
The setup-gradle action tries to get a short-lived access token given the supplied Develocity access key.
This key can be passed either with the `DEVELOCITY_ACCESS_KEY` env var or via the  `develocity-access-key` input parameter.
If a token can be retrieved, then the `DEVELOCITY_ACCESS_KEY` env var will be set to the token. 
Otherwise the `DEVELOCITY_ACCESS_KEY` will be set to a blank string, to avoid a leak.

---------

Co-authored-by: daz <daz@gradle.com>
2024-05-15 16:49:55 -06:00
Daz DeBoer d211a39090 Documentation updates (#187)
* Use consistent YAML syntax in example workflows
* Add link to plugin env vars
2024-04-18 09:39:15 -06:00
daz 92975d7f32 Allow a task name to be specified for dependency-submission
Fixes: #125
2024-04-09 08:46:20 -06:00
daz 38a821729e Use consistent action params between setup-gradle and dependency-submission
To ensure expected caching (and other) behaviour, we should keep these config
parameters as consistent as possible.
2024-04-07 12:11:50 -06:00
daz 627fa7627c Revert "Provide default config values for dependency-submission"
This reverts commit b7ef93c7b7.
2024-04-07 11:54:02 -06:00
daz b7ef93c7b7 Provide default config values for dependency-submission 2024-04-07 11:00:34 -06:00
daz ebf4d13461 Convert dependency-submission action to Typescript
Instead of being a thin wrapper over `setup-gradle`, the `dependency-submission`
action is now a fully-fledged action sharing implementation with `setup-gradle`.
2024-04-06 19:31:04 -06:00
daz 340a6438d0 Add 'setup-java' step to all examples 2024-04-05 14:54:29 -06:00
Daz DeBoer 0b06ce12c8 Restructure documentation and add a dependency-submission FAQ (#110) 2024-04-04 16:38:14 -06:00
daz e24011a3b5 Update dependency-submission action for 3.2.0
- Point to `setup-gradle` v3.2.0
- Add back in removed inputs
2024-04-04 13:33:06 -06:00
Pavlo Shevchenko 5a171ce5b8 Inject Develocity plugin for versions 3.17 and above (#62)
To handle the rebranding of the GE plugin, this PR updates the inject-develocity init script 
to apply the `com.gradle.develocity` plugin if `3.17+` version of the plugin is requested.
2024-04-03 14:47:50 -06:00
Daz DeBoer f58a414c4f Fix typo 2024-03-11 19:37:21 -06:00
daz 417ae3ccd7 Prepare for v3.1.0 release 2024-02-13 13:04:08 -07:00
Daz DeBoer 8a945e8ba7 Document use of debug logging with dependency-submission 2024-02-13 09:38:01 -07:00
daz 109be5d55b Disable isolated projects in dependency-submission
The 'resolveAllDependencies' task is incompatible with project isolation.
Pending a fix to the plugin, disable this feature when running the
dependency-submission action.

Fixes #39
2024-02-11 15:56:13 -07:00
Daz DeBoer b776693a71 Fail nicely when dependency-submission is used after setup-gradle in the same Job (#37)
Previously, this would fail with a hard-to-diagnose error message.

Fixes #14
2024-02-08 23:16:54 -07:00
daz dfd22334ff Use gradle properties to disable features instead of CLI args
These gradle properties will be silently ignored on older Gradle versions,
whereas unknown command-line args will cause Gradle to fail.

Fixes #15
2024-02-08 21:55:52 -07:00
Goooler bc07b88bc0 Update Gradle 8.6 rc refs to the final version
https://github.com/gradle/gradle/releases/tag/v8.6.0

Signed-off-by: Goooler <wangzongler@gmail.com>
2024-02-08 21:38:25 -07:00
Daz DeBoer 7fda81ffd5 Document auto-publish of build scans 2024-01-31 13:04:12 -07:00
Daz DeBoer e4ee7d7f94 Document process for resolving a vulnerability (#8) 2024-01-31 12:42:07 -07:00
Daz DeBoer a02bb79881 Introduce a top-level section for "resolving a vulnerability" 2024-01-31 12:23:08 -07:00
Daz DeBoer 52d6180f95 Add 'finding dependency source' section to docs (#7) 2024-01-31 12:17:45 -07:00
daz ec92e82947 Prepare for v3.0.0 release 2024-01-31 04:14:38 -07:00
daz aff52e5be9 More docs improvements 2024-01-29 11:04:02 -07:00
daz 354bf99f5f Update docs 2024-01-29 10:46:26 -07:00
daz 0ac0f49dd2 Replace 'v3-beta' with 'v3' in docs 2024-01-29 10:46:26 -07:00
daz 0f26c9acd8 Limit artifact retention with dependency-submission 2024-01-29 10:46:26 -07:00
daz 11fb430abc Update dependency-submission parameter for consistency
Instead of using 'dependency-graph-action' with some slightly better
values, we now use 'dependency-graph' as the parameter name with a subset
of the options available to 'setup-gradle'.
2024-01-29 10:46:26 -07:00
daz 58d5bdcbe5 Allow additional arguments for resolve-all-dependencies
At times, additional CLI args may be required to invoke Gradle.
Add a parameter to provide these args.
2024-01-28 14:07:13 -07:00
daz 3247582571 Make it easy to publish build scans from 'dependency-submission' 2024-01-28 14:03:37 -07:00
daz bd134735f1 Attempt to use setup-gradle from dependency-submission 2024-01-25 12:45:33 -07:00
daz daf65fafa6 Remove branch specification from examples 2024-01-22 18:02:30 -07:00
daz 40c351e1fe Improve documentation
- Provide summary of each action on main page
- Extract detailed documentation for each action
- Document usage with forked repositories
2024-01-22 16:15:33 -07:00
daz d731f29856 Use separate steps in composite action 2024-01-22 11:13:02 -07:00
daz 23b4b1d03b Add 'dependency-graph-action' input param 2024-01-22 11:02:29 -07:00
daz d3baa4b30f Use gradle-build-action@v3-beta 2024-01-16 18:53:18 -07:00