Expose cache hit as output (#5)

bitrise-steplib · Jan 12, 2023 · 6772a96 · 6772a96
1 parent b0a78d9
commit 6772a96
Show file tree

Hide file tree

Showing 9 changed files with 47 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -55,7 +55,10 @@ steps:
 
 <details>
 <summary>Outputs</summary>
-There are no outputs defined in this step
+
+| Environment Variable | Description |
+| --- | --- |
+| `BITRISE_CACHE_HIT` | Indicates if a cache entry was restored. Possible values: - `exact`: Exact cache hit for the first requested cache key - `partial`: Cache hit for a key other than the first - `false` No cache hit, nothing was restored |
 </details>
 
 ## 🙋 Contributing

diff --git a/go.mod b/go.mod
@@ -3,7 +3,7 @@ module github.com/bitrise-steplib/steps-restore-gradle-cache
 go 1.17
 
 require (
-	github.com/bitrise-io/go-steputils/v2 v2.0.0-alpha.15
+	github.com/bitrise-io/go-steputils/v2 v2.0.0-alpha.16
 	github.com/bitrise-io/go-utils/v2 v2.0.0-alpha.13
 )
 

diff --git a/go.sum b/go.sum
@@ -1,5 +1,5 @@
-github.com/bitrise-io/go-steputils/v2 v2.0.0-alpha.15 h1:wG037NV+pS8cEwtalE5K58bmKLyUkU0+4m4IuXjTzmo=
-github.com/bitrise-io/go-steputils/v2 v2.0.0-alpha.15/go.mod h1:M09BbxYoh6B7KJnXk/yvtuU5nZPh7RQBJGKc1dp+0hQ=
+github.com/bitrise-io/go-steputils/v2 v2.0.0-alpha.16 h1:WA0QxrFG6ZeBTFsjBsqnCYwlfW0WRDuxGX74a2ffWRw=
+github.com/bitrise-io/go-steputils/v2 v2.0.0-alpha.16/go.mod h1:M09BbxYoh6B7KJnXk/yvtuU5nZPh7RQBJGKc1dp+0hQ=
 github.com/bitrise-io/go-utils v1.0.1 h1:e7mepVBkVN1DXRPESNXb0djEw6bxB6B93p/Q74zzcvk=
 github.com/bitrise-io/go-utils v1.0.1/go.mod h1:ZY1DI+fEpZuFpO9szgDeICM4QbqoWVt0RSY3tRI1heY=
 github.com/bitrise-io/go-utils/v2 v2.0.0-alpha.13 h1:QtAAfm/FpMDv/PnDxgzylVbbSx21pyl7+5T/ToJnWAQ=

diff --git a/step.yml b/step.yml
@@ -47,3 +47,13 @@ inputs:
     value_options:
     - "true"
     - "false"
+
+outputs:
+- BITRISE_CACHE_HIT:
+  opts:
+    title: Cache hit
+    description: |-
+      Indicates if a cache entry was restored. Possible values:
+      - `exact`: Exact cache hit for the first requested cache key
+      - `partial`: Cache hit for a key other than the first
+      - `false` No cache hit, nothing was restored
diff --git a/vendor/github.com/bitrise-io/go-steputils/v2/cache/common.go b/vendor/github.com/bitrise-io/go-steputils/v2/cache/common.go
diff --git a/vendor/github.com/bitrise-io/go-steputils/v2/cache/restore.go b/vendor/github.com/bitrise-io/go-steputils/v2/cache/restore.go
diff --git a/vendor/github.com/bitrise-io/go-steputils/v2/cache/save_skip.go b/vendor/github.com/bitrise-io/go-steputils/v2/cache/save_skip.go
diff --git a/vendor/github.com/bitrise-io/go-steputils/v2/cache/tracker.go b/vendor/github.com/bitrise-io/go-steputils/v2/cache/tracker.go
diff --git a/vendor/modules.txt b/vendor/modules.txt
@@ -1,4 +1,4 @@
-# github.com/bitrise-io/go-steputils/v2 v2.0.0-alpha.15
+# github.com/bitrise-io/go-steputils/v2 v2.0.0-alpha.16
 ## explicit; go 1.17
 github.com/bitrise-io/go-steputils/v2/cache
 github.com/bitrise-io/go-steputils/v2/cache/compression