Skip to content

Commit df3a956

Browse files
aleasimsaleasims
committed
Initial commit
0 parents  commit df3a956

File tree

18 files changed

+298809
-0
lines changed

18 files changed

+298809
-0
lines changed

‎.github/workflows/check-dist.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: check dist/
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths-ignore:
8+
- "**.md"
9+
pull_request:
10+
paths-ignore:
11+
- "**.md"
12+
workflow_dispatch:
13+
14+
jobs:
15+
check-dist:
16+
if: github.repository == 'aleasims/go-cache'
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@v5
20+
21+
- name: Setup Node.js 20.x
22+
uses: actions/setup-node@v5
23+
with:
24+
node-version: 20.x
25+
cache: npm
26+
27+
- name: Install dependencies
28+
run: npm ci
29+
30+
- name: Rebuild the dist/ directory
31+
run: npm run prepare
32+
33+
- name: Compare the expected and actual dist/ directories
34+
run: |
35+
if [ "$(git diff dist/ | wc -l)" -gt "0" ]; then
36+
echo "Detected uncommitted changes after build. See status below:"
37+
git diff
38+
exit 1
39+
fi
40+
id: diff
41+
42+
- uses: actions/upload-artifact@v4
43+
if: ${{ failure() && steps.diff.conclusion == 'failure' }}
44+
with:
45+
name: dist
46+
path: dist/

‎.github/workflows/simple-module.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: simple-module
2+
3+
on: [push, pull_request]
4+
5+
permissions: {}
6+
7+
jobs:
8+
simple:
9+
if: github.repository == 'aleasims/go-cache'
10+
strategy:
11+
fail-fast: false
12+
matrix:
13+
os: [ubuntu-latest, macos-latest, windows-latest]
14+
15+
name: Test `go build` on ${{ matrix.os }}
16+
runs-on: ${{ matrix.os }}
17+
18+
steps:
19+
- name: Checkout code
20+
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
21+
with:
22+
persist-credentials: false
23+
24+
- name: Ensure Go installed on MacOS
25+
if: ${{ matrix.os == 'macos-latest' }}
26+
uses: actions/setup-go@v5
27+
with:
28+
cache: false
29+
go-version-file: "tests/simple-module/go.mod"
30+
31+
- name: Show Go env
32+
run: go env
33+
34+
- name: Run action
35+
uses: ./
36+
with:
37+
modules: tests/simple-module
38+
39+
- name: Go build
40+
run: go build
41+
working-directory: tests/simple-module

‎.gitignore‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
node_modules/
2+
3+
# Editors
4+
.idea/
5+
.vscode/
6+
7+
# Mac
8+
.DS_Store

‎LICENSE‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

‎README.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Go Cache Action
2+
3+
A GitHub Action that implements smart caching for Go projects with
4+
sensible defaults.
5+
6+
This project is an adaptation of [Swatinem/rust-cache](https://github.com/Swatinem/rust-cache) for Go.
7+
8+
## Example of usage
9+
10+
```yaml
11+
- uses: aleasims/go-cache@v1
12+
with:
13+
# The prefix cache key, this can be changed to start a new cache manually.
14+
# default: "v0-go"
15+
prefix-key: ""
16+
17+
# A cache key that is used instead of the automatic `job`-based key,
18+
# and is stable over multiple jobs.
19+
# default: empty
20+
shared-key: ""
21+
22+
# An additional cache key that is added alongside the automatic `job`-based
23+
# cache key and can be used to further differentiate jobs.
24+
# default: empty
25+
key: ""
26+
27+
# A whitespace separated list of env-var *prefixes* who's value contributes
28+
# to the environment cache key.
29+
# The env-vars are matched by *prefix*.
30+
# default: "CC CFLAGS CXX CMAKE"
31+
env-vars: ""
32+
33+
# The modules paths.
34+
# A newline separated list of paths to directories with go.mod files.
35+
# default: "."
36+
modules: ""
37+
38+
# Additional non workspace directories to be cached, separated by newlines.
39+
cache-directories: ""
40+
41+
# Determines if the cache should be saved even when the workflow has failed.
42+
# default: "false"
43+
cache-on-failure: ""
44+
45+
# Determines whether the cache should be saved.
46+
# If `false`, the cache is only restored.
47+
# default: "true"
48+
save-if: ""
49+
# To only cache runs from `master`:
50+
save-if: ${{ github.ref == 'refs/heads/master' }}
51+
52+
# Determines whether the cache should be restored.
53+
# If `true` the cache key will be checked and the `cache-hit` output will be set
54+
# but the cache itself won't be restored
55+
# default: "false"
56+
lookup-only: ""
57+
58+
# Specifies what to use as the backend providing cache
59+
# Can be set to "github", "buildjet", or "warpbuild"
60+
# default: "github"
61+
cache-provider: ""
62+
63+
# Determines whether to cache the $GOBIN directory.
64+
# default: "true"
65+
cache-bin: ""
66+
```

‎action.yml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: "Go Cache"
2+
description: "A GitHub Action that implements caching for Go projects."
3+
author: "Alexander Evgin <aleasims@gmail.com>"
4+
inputs:
5+
prefix-key:
6+
description: "The prefix cache key, this can be changed to start a new cache manually."
7+
required: false
8+
default: "v0-go"
9+
shared-key:
10+
description: "A cache key that is used instead of the automatic `job`-based key, and is stable over multiple jobs."
11+
required: false
12+
key:
13+
description: "An additional cache key that is added alongside the automatic `job`-based cache key and can be used to further differentiate jobs."
14+
required: false
15+
env-vars:
16+
description: "Additional environment variables to include in the cache key, separated by spaces."
17+
required: false
18+
modules:
19+
description: "Paths to multiple Go modules, separated by newlines."
20+
required: false
21+
cache-directories:
22+
description: "Additional non workspace directories to be cached, separated by newlines."
23+
required: false
24+
cache-on-failure:
25+
description: "Cache even if the build fails. Defaults to false."
26+
required: false
27+
save-if:
28+
description: "Determiners whether the cache should be saved. If `false`, the cache is only restored."
29+
required: false
30+
default: "true"
31+
cache-provider:
32+
description: "Determines which provider to use for caching. Options are github, buildjet, or warpbuild. Defaults to github."
33+
required: false
34+
default: "github"
35+
cache-bin:
36+
description: "Determines whether to cache $GOBIN."
37+
required: false
38+
default: "true"
39+
lookup-only:
40+
description: "Check if a cache entry exists without downloading the cache"
41+
required: false
42+
default: "false"
43+
outputs:
44+
cache-hit:
45+
description: "A boolean value that indicates an exact match was found."
46+
runs:
47+
using: "node24"
48+
main: "dist/restore/index.js"
49+
post: "dist/save/index.js"
50+
post-if: "success() || env.CACHE_ON_FAILURE == 'true'"
51+
branding:
52+
icon: "archive"
53+
color: "blue"

0 commit comments

Comments
 (0)