Commit graph

116 commits

Author SHA1 Message Date
Daz DeBoer
bd57605957
Remove 'experimental' from chapter title 2023-07-10 10:26:35 -06:00
Daz DeBoer
f464d5c9e5
Improve docs for dependency-graph 2023-07-10 10:23:31 -06:00
Daz DeBoer
9a4d99b236
Add initial docs for dependency-graph support 2023-07-07 20:42:49 -06:00
Daz DeBoer
631021bf98
Document the generate-job-summary options
Fixes #646
2023-05-23 14:56:51 -06:00
Daz DeBoer
749f47bda3
Update README.md for changes in release 2023-04-14 16:29:18 -06:00
Daz DeBoer
eb126d771e
Update for Gradle 8.1 release
With Gradle 8.1, the configuration-cache has changed and is now stable. 
As a temporary measure, this commit disables save/restore of the configuration-cache
data to avoid issues until we can deal with this change properly.
2023-04-14 16:23:09 -06:00
Daz DeBoer
5abf330283
Merge pull request #516 from KENNYSOFT/build-scan-capture-guide
Add init scripts file name guide for build scan capturing
2023-02-06 14:10:53 -07:00
Daz DeBoer
e0391a3985
Merge pull request #528 from SonicGDX/patch-1
Update Link in README.md
2023-02-06 12:48:34 -07:00
Daz DeBoer
09af07ef76
Update readme for GHES 3.6 2023-02-06 12:45:48 -07:00
SonicGDX
935e8941dd
Update Link in README.md
One of the links didn't go anywhere, so I changed it to what is likely the intended location.

Signed-off-by: SonicGDX <114670430+SonicGDX@users.noreply.github.com>
2022-12-24 16:24:05 +00:00
Hyeonmin Park
1e6c29c1af
Add init scripts file name guide for build scan capturing
Signed-off-by: Hyeonmin Park <hyeonmin.park@kennysoft.kr>
2022-11-28 00:22:26 +09:00
Daz DeBoer
1761dcff13
Document gradle-home-cache-cleanup 2022-08-29 11:47:27 -06:00
Daz DeBoer
86acd2a1fd
Update README.md 2022-07-25 17:45:58 -06:00
Daz DeBoer
15453523bd
Improve documentation of cache-read-only 2022-07-11 12:27:54 -06:00
Jakob
e7f3e4d839
Fix typo in README.md
exising -> existing

Signed-off-by: SIMULATAN <simulatan2319@gmail.com>
2022-07-03 12:29:54 +02:00
Daz DeBoer
32923891b5
Note daemon stopping behaviour in README
Text provided by @milis92
2022-06-22 16:52:00 -06:00
Daz DeBoer
7f46dbd76f
Document support for GitHub Enterprise Server 2022-06-20 20:46:57 -06:00
Daz DeBoer
2335d51128
Add mandatory 'distribution' param for setup-java 2022-06-14 12:11:44 -06:00
Daz DeBoer
e88ed3e650
Update README for v2.2.0 2022-06-06 12:34:02 -06:00
Daz DeBoer
9ab4abd18c
Update to latest version of all github actions 2022-06-04 09:26:11 -06:00
Daz DeBoer
ae74c01440
Use a BuildService to always collect project root
Using `settingsEvaluated` meant that the project root was not recorded
when the build was run with a config-cache hit. This meant that the subsequent
build would not restore the config-cache, resulting in a cache miss.

In order to avoid issues running the init script on older versions of Gradle
the project-collection is extracted into a separate groovy file that is only
applied conditionally on Gradle 7 or higher.
2022-06-03 13:51:36 -06:00
Daz DeBoer
94d04eaa0d
Fix typo in README 2022-05-15 18:33:34 -06:00
osfanbuff63
477313b699
Fix readme markdown
Signed-off-by: osfanbuff63 <91388253+osfanbuff63@users.noreply.github.com>
2022-04-15 08:43:05 -04:00
Daz DeBoer
9230b19200
Fix typo in README 2022-04-06 11:30:02 -06:00
Daz DeBoer
cde360986c
Improve sample for build-scan comment on PR 2022-04-04 15:12:03 -06:00
Daz DeBoer
ff8a687227
Document use of upload-artifact to save build outputs 2022-04-04 15:07:16 -06:00
Daz DeBoer
a7260b277e
Specify mandatory 'distribution' arg for setup-java 2022-01-17 14:28:53 -07:00
Daz DeBoer
f4e053dda1
Upgrade to reference actions/setup-java@v2
- Update all references in README.md
- Update version used in `pr-build-scan-comment`
- Discourage the use of `cache: gradle` with `setup-java@v2`
2022-01-16 16:18:09 -07:00
Benedikt Ritter
a7c463b44a
Update to latest version of actions/github-script
See https://github.com/marketplace/actions/github-script#breaking-changes-in-v5

* Update docs to latest github-script action version
* Update CI build to latest GitHub API
2022-01-16 15:45:15 -07:00
Daz DeBoer
3609b7787a
Polish README for v2.1 2021-12-30 18:12:37 -07:00
Daz DeBoer
b4e6c2b28a
Minor improvements to README 2021-12-17 13:34:22 -07:00
Daz DeBoer
40c0a12211
Update README for use without Gradle execution 2021-12-17 10:29:59 -07:00
Daz DeBoer
c12283ec57
Add a section explaining advantages 2021-11-01 12:35:15 -06:00
Daz DeBoer
f2dc0d8256
Add section on optimizing cache effectiveness 2021-11-01 08:17:33 -06:00
Daz DeBoer
e3ada7e5c2
Use multiline input parameters instead of JSON input
The `gradle-home-cache-includes` and `gradle-home-cache-excludes` parameters were initially implemented
as JSON string inputs. This makes these inputs non-idiomatic and easier to get wrong.

This change converts them to multi-line input parameters.

Fixes #106
2021-10-29 07:29:57 -06:00
Daz DeBoer
d61e5be06a
Remove note about Beta release from README 2021-10-27 16:27:21 -06:00
Daz DeBoer
27f2dc276c
Rename and document parameters for clarity
- cache-paths -> gradle-home-cache-includes
- cache-exclude-paths -> gradle-home-cache-excludes
- CACHE_DEBUG_ENABLED -> GRADLE_BUILD_ACTION_CACHE_DEBUG_ENABLED
2021-10-27 16:05:07 -06:00
Daz DeBoer
d1ab42cddf
Document support for multi-line arguments
Fixes #88
2021-10-15 12:24:41 -06:00
Daz DeBoer
aedc5fc8f9
Mention that CACHE_DEBUG_ENABLED will disable parallel save/restore 2021-10-14 10:41:45 -06:00
Daz DeBoer
78e25cd233
Document the CACHE_DEBUG_ENABLED flag 2021-10-14 10:39:12 -06:00
Daz DeBoer
21dee71590
Update README for v2 2021-09-28 11:30:55 -06:00
Daz DeBoer
986024f0b7
Adapt README and workflow for new caching 2021-08-26 17:25:50 -06:00
Daz DeBoer
e7422f245c
Fix typo in README 2021-08-22 14:42:01 -06:00
Daz DeBoer
a693ccda4b
Allow use of caches 'read-only'
To avoid evicting useful entries, some pipeline may benefit from using existing
cache entries without writing any changes back to the cache.

Fixes #62
2021-08-22 14:28:34 -06:00
Daz DeBoer
88af98fab4
Fail if configuration-cache is enabled without dependencies cache
Fixes #61
2021-08-07 16:13:35 -07:00
Daz DeBoer
01bfa29846
Update metadata and docs for repository move/rename
Fixes #60
2021-08-07 16:13:35 -07:00
Daz DeBoer
b9684c0cf5
Prefer ‘release-candidate’ instead of ‘rc’
This makes the version alias match other places where we reference a release candidate version.
The 'rc' alias is still supported, but emits a deprecation warning.
2021-07-26 14:54:59 -06:00
Daz DeBoer
5423935c9b
Deprecate the 'wrapper-directory' input and recommend 'gradle-executable' instead
Use of a wrapper in a non-standard directory is uncommon, and is effectively handled
by referencing the `gradlew` script as the `gradle-executable`.
2021-07-26 14:54:59 -06:00
Daz DeBoer
33e91b639d
Cache Gradle distributions downloaded for a particular version (#58)
- Cache is separate from (but similar to) the wrapper distribution cache
- New 'distributions-cache-enabled' flag controls caching of all downloaded distributions
  (including wrapper distributions)
- Deprecated the 'wrapper-cache-enabled' flag for removal in v2
2021-07-08 12:22:48 -06:00
Tomaz Muraus
15bf8034d6 Fix typo, the directory which contains dependency locks is named
gradle/dependency-locks.
2020-12-22 12:13:55 +01:00
Benedikt Ritter
ced6c34563 Add worknig example for build scan comment
Replaces the dummy example for how to automatically add a comment containing the build scan URL
with a working example using the [GitHub Script action](https://github.com/marketplace/actions/github-script#comment-on-an-issue).

See https://github.com/britter/maven-plugin-development/pull/56#issuecomment-708406163 for how it looks in action.
2020-10-14 15:57:13 +02:00
Paul Merlin
eb7eb78d95 Refine README 2020-06-15 16:50:15 +02:00
Paul Merlin
3c43b6525f Add some documentation around caching 2020-06-15 16:23:01 +02:00
Paul Merlin
e8885a31b8 Refine README 2020-06-14 12:57:10 +02:00
Paul Merlin
f25026ba74 Refine README 2020-06-13 12:45:21 +02:00
Paul Merlin
9f5ce3593a
Fix typo 2020-04-18 17:10:08 +02:00
Ivan Shcherbak
a5009d1aec Fix typo
Get an error from Github: `pull-request is not a valid event name`

https://help.github.com/en/actions/reference/events-that-trigger-workflows#example-using-a-list-of-events
2020-04-18 17:09:21 +02:00
Frieder Bluemle
ae5079ecac Fix GitHub spelling 2020-03-17 22:36:04 +01:00
Vladimir Orany
c8b76ea3f7
Update README.md 2019-12-09 10:46:30 +01:00
Paul Merlin
dc882d2669 fix yaml comments in README's samples 2019-09-23 13:00:12 +02:00
Paul Merlin
f9f0422c72 add example of using the build-scan-url output in README 2019-09-23 12:56:08 +02:00
Paul Merlin
f943246fd9 refine readme 2019-09-23 12:10:22 +02:00
Paul Merlin
76166f0035 refine readme 2019-09-21 21:02:16 +02:00
Paul Merlin
6f837e9062 Minor README edits 2019-09-21 16:04:03 +02:00
Paul Merlin
bc921df1ec Initial impl 2019-09-21 16:01:53 +02:00
Paul Merlin
8ba9907b46 Initial commit 2019-09-20 23:06:59 +02:00