├── .all-contributorsrc
├── .github
├── dependabot.yml
├── release.yml
└── workflows
│ ├── auto-merge-dependabot.yml
│ ├── ci.yml
│ ├── code_coverage_comment.yml
│ ├── release_auto.yml
│ ├── release_pr_snapshot.yml
│ └── remove_snapshot_branch.yml
├── .gitignore
├── CODE_OF_CONDUCT.md
├── LICENSE
├── README.md
├── action.yml
├── package-lock.json
├── package.json
├── src
├── action
│ ├── main.ts
│ ├── post.ts
│ └── pre.ts
├── core
│ ├── cache.ts
│ ├── files.ts
│ ├── http.ts
│ ├── logger.ts
│ ├── os.ts
│ └── types.ts
├── modules
│ ├── coursier.ts
│ ├── github.test.ts
│ ├── github.ts
│ ├── healthcheck.test.ts
│ ├── healthcheck.ts
│ ├── input.test.ts
│ ├── input.ts
│ ├── mill.ts
│ ├── workspace.test.ts
│ └── workspace.ts
└── utils
│ └── docs.ts
└── tsconfig.json
/.all-contributorsrc:
--------------------------------------------------------------------------------
1 | {
2 | "projectName": "scala-steward-action",
3 | "projectOwner": "scala-steward-org",
4 | "repoType": "github",
5 | "repoHost": "https://github.com",
6 | "files": [
7 | "README.md"
8 | ],
9 | "imageSize": 100,
10 | "commit": true,
11 | "commitConvention": "none",
12 | "contributorsSortAlphabetically": "true",
13 | "contributors": [
14 | {
15 | "login": "alejandrohdezma",
16 | "name": "Alejandro Hernández",
17 | "avatar_url": "https://avatars.githubusercontent.com/u/9027541?v=4",
18 | "profile": "https://alejandrohdezma.com/",
19 | "contributions": [
20 | "code"
21 | ]
22 | },
23 | {
24 | "login": "laughedelic",
25 | "name": "Alexey Alekhin",
26 | "avatar_url": "https://avatars.githubusercontent.com/u/766656?v=4",
27 | "profile": "https://github.com/laughedelic",
28 | "contributions": [
29 | "code"
30 | ]
31 | },
32 | {
33 | "login": "fthomas",
34 | "name": "Frank Thomas",
35 | "avatar_url": "https://avatars.githubusercontent.com/u/141252?v=4",
36 | "profile": "https://github.com/fthomas",
37 | "contributions": [
38 | "code"
39 | ]
40 | },
41 | {
42 | "login": "ryota0624",
43 | "name": "ryota0624",
44 | "avatar_url": "https://avatars.githubusercontent.com/u/11390724?v=4",
45 | "profile": "https://github.com/ryota0624",
46 | "contributions": [
47 | "code"
48 | ]
49 | },
50 | {
51 | "login": "arashi01",
52 | "name": "Ali Salim Rashid",
53 | "avatar_url": "https://avatars.githubusercontent.com/u/1921493?v=4",
54 | "profile": "https://github.com/arashi01",
55 | "contributions": [
56 | "code"
57 | ]
58 | },
59 | {
60 | "login": "xuwei-k",
61 | "name": "kenji yoshida",
62 | "avatar_url": "https://avatars.githubusercontent.com/u/389787?v=4",
63 | "profile": "https://twitter.com/xuwei_k",
64 | "contributions": [
65 | "code",
66 | "question"
67 | ]
68 | },
69 | {
70 | "login": "EwoutH",
71 | "name": "Ewout ter Hoeven",
72 | "avatar_url": "https://avatars.githubusercontent.com/u/15776622?v=4",
73 | "profile": "https://github.com/EwoutH",
74 | "contributions": [
75 | "code"
76 | ]
77 | },
78 | {
79 | "login": "MPV",
80 | "name": "Victor Sollerhed",
81 | "avatar_url": "https://avatars.githubusercontent.com/u/62675?v=4",
82 | "profile": "http://victor.sollerhed.se/",
83 | "contributions": [
84 | "code"
85 | ]
86 | },
87 | {
88 | "login": "NomadBlacky",
89 | "name": "Takumi Kadowaki",
90 | "avatar_url": "https://avatars.githubusercontent.com/u/3215961?v=4",
91 | "profile": "https://www.nomadblacky.dev/",
92 | "contributions": [
93 | "code"
94 | ]
95 | },
96 | {
97 | "login": "TonioGela",
98 | "name": "Antonio Gelameris",
99 | "avatar_url": "https://avatars.githubusercontent.com/u/41690956?v=4",
100 | "profile": "https://toniogela.dev/",
101 | "contributions": [
102 | "code"
103 | ]
104 | },
105 | {
106 | "login": "bpg",
107 | "name": "Pavel Boldyrev",
108 | "avatar_url": "https://avatars.githubusercontent.com/u/627562?v=4",
109 | "profile": "http://ca.linkedin.com/in/pboldyrev/",
110 | "contributions": [
111 | "code"
112 | ]
113 | },
114 | {
115 | "login": "tovbinm",
116 | "name": "Matthew Tovbin",
117 | "avatar_url": "https://avatars.githubusercontent.com/u/629845?v=4",
118 | "profile": "https://www.tovbin.com/",
119 | "contributions": [
120 | "code"
121 | ]
122 | },
123 | {
124 | "login": "michele-pinto-kensu",
125 | "name": "Michele Pinto",
126 | "avatar_url": "https://avatars.githubusercontent.com/u/69146696?v=4",
127 | "profile": "https://github.com/michele-pinto-kensu",
128 | "contributions": [
129 | "ideas"
130 | ]
131 | },
132 | {
133 | "login": "spliakos",
134 | "name": "Stefanos Pliakos",
135 | "avatar_url": "https://avatars.githubusercontent.com/u/15560159?v=4",
136 | "profile": "https://github.com/spliakos",
137 | "contributions": [
138 | "ideas"
139 | ]
140 | },
141 | {
142 | "login": "jshiell",
143 | "name": "Jamie Shiell",
144 | "avatar_url": "https://avatars.githubusercontent.com/u/1030482?v=4",
145 | "profile": "https://infernus.org/",
146 | "contributions": [
147 | "bug"
148 | ]
149 | },
150 | {
151 | "login": "marcelocarlos",
152 | "name": "Marcelo Carlos",
153 | "avatar_url": "https://avatars.githubusercontent.com/u/16080771?v=4",
154 | "profile": "https://github.com/marcelocarlos",
155 | "contributions": [
156 | "bug"
157 | ]
158 | },
159 | {
160 | "login": "jeffboutotte",
161 | "name": "Jeff Boutotte",
162 | "avatar_url": "https://avatars.githubusercontent.com/u/6991403?v=4",
163 | "profile": "https://github.com/jeffboutotte",
164 | "contributions": [
165 | "code"
166 | ]
167 | },
168 | {
169 | "login": "milanvdm",
170 | "name": "Milan van der Meer",
171 | "avatar_url": "https://avatars.githubusercontent.com/u/5628925?v=4",
172 | "profile": "https://github.com/milanvdm",
173 | "contributions": [
174 | "bug"
175 | ]
176 | },
177 | {
178 | "login": "exoego",
179 | "name": "TATSUNO Yasuhiro",
180 | "avatar_url": "https://avatars.githubusercontent.com/u/127635?v=4",
181 | "profile": "https://www.exoego.net/",
182 | "contributions": [
183 | "code"
184 | ]
185 | },
186 | {
187 | "login": "francisdb",
188 | "name": "Francis De Brabandere",
189 | "avatar_url": "https://avatars.githubusercontent.com/u/161305?v=4",
190 | "profile": "https://github.com/francisdb",
191 | "contributions": [
192 | "bug"
193 | ]
194 | },
195 | {
196 | "login": "armanbilge",
197 | "name": "Arman Bilge",
198 | "avatar_url": "https://avatars.githubusercontent.com/u/3119428?v=4",
199 | "profile": "https://github.com/armanbilge",
200 | "contributions": [
201 | "bug",
202 | "code"
203 | ]
204 | },
205 | {
206 | "login": "ybasket",
207 | "name": "Yannick Heiber",
208 | "avatar_url": "https://avatars.githubusercontent.com/u/2632023?v=4",
209 | "profile": "https://github.com/ybasket",
210 | "contributions": [
211 | "code",
212 | "bug"
213 | ]
214 | },
215 | {
216 | "login": "wunderk1nd-e",
217 | "name": "Elias Court",
218 | "avatar_url": "https://avatars.githubusercontent.com/u/36158087?v=4",
219 | "profile": "https://k1nd.ltd/",
220 | "contributions": [
221 | "code"
222 | ]
223 | },
224 | {
225 | "login": "leobenkel",
226 | "name": "Leo Benkel",
227 | "avatar_url": "https://avatars.githubusercontent.com/u/4960573?v=4",
228 | "profile": "https://leobenkel.com/",
229 | "contributions": [
230 | "bug"
231 | ]
232 | },
233 | {
234 | "login": "anatoliykmetyuk",
235 | "name": "Anatolii Kmetiuk",
236 | "avatar_url": "https://avatars.githubusercontent.com/u/2614813?v=4",
237 | "profile": "https://akmetiuk.com/",
238 | "contributions": [
239 | "doc"
240 | ]
241 | },
242 | {
243 | "login": "jyrkih",
244 | "name": "Jyrki Hokkanen",
245 | "avatar_url": "https://avatars.githubusercontent.com/u/2580851?v=4",
246 | "profile": "https://github.com/jyrkih",
247 | "contributions": [
248 | "bug"
249 | ]
250 | },
251 | {
252 | "login": "yokra9",
253 | "name": "yokra",
254 | "avatar_url": "https://avatars.githubusercontent.com/u/53964890?v=4",
255 | "profile": "https://qiita.com/yokra9",
256 | "contributions": [
257 | "doc"
258 | ]
259 | },
260 | {
261 | "login": "ckipp01",
262 | "name": "Chris Kipp",
263 | "avatar_url": "https://avatars.githubusercontent.com/u/13974112?v=4",
264 | "profile": "https://chris-kipp.io/",
265 | "contributions": [
266 | "bug",
267 | "code"
268 | ]
269 | },
270 | {
271 | "login": "regadas",
272 | "name": "Filipe Regadas",
273 | "avatar_url": "https://avatars.githubusercontent.com/u/163899?v=4",
274 | "profile": "https://regadas.dev/",
275 | "contributions": [
276 | "doc"
277 | ]
278 | },
279 | {
280 | "login": "fmeriaux",
281 | "name": "Florian Meriaux",
282 | "avatar_url": "https://avatars.githubusercontent.com/u/16759768?v=4",
283 | "profile": "https://github.com/fmeriaux",
284 | "contributions": [
285 | "bug"
286 | ]
287 | },
288 | {
289 | "login": "adamw",
290 | "name": "Adam Warski",
291 | "avatar_url": "https://avatars.githubusercontent.com/u/60503?v=4",
292 | "profile": "http://www.warski.org/",
293 | "contributions": [
294 | "question"
295 | ]
296 | },
297 | {
298 | "login": "SpecialThing44",
299 | "name": "Spencer Perkins",
300 | "avatar_url": "https://avatars.githubusercontent.com/u/95900100?v=4",
301 | "profile": "https://github.com/SpecialThing44",
302 | "contributions": [
303 | "doc"
304 | ]
305 | }
306 | ],
307 | "contributorsPerLine": 6
308 | }
309 |
--------------------------------------------------------------------------------
/.github/dependabot.yml:
--------------------------------------------------------------------------------
1 | version: 2
2 | updates:
3 | - package-ecosystem: "github-actions"
4 | directory: "/"
5 | schedule:
6 | interval: "monthly"
7 | - package-ecosystem: npm
8 | directory: "/"
9 | schedule:
10 | interval: monthly
11 |
--------------------------------------------------------------------------------
/.github/release.yml:
--------------------------------------------------------------------------------
1 | changelog:
2 | exclude:
3 | labels:
4 | - ":chart_with_upwards_trend: dependency-update"
5 | authors:
6 | - dependabot
7 | categories:
8 | - title: "⚠️ Breaking changes"
9 | labels:
10 | - ":warning: breaking"
11 | - title: "🚀 New features"
12 | labels:
13 | - ":rocket: feature"
14 | - title: "📘 Documentation updates"
15 | labels:
16 | - ":blue_book: documentation"
17 | - title: "🐛 Bug fixes"
18 | labels:
19 | - ":beetle: bug"
20 | - title: Other Changes
21 | labels:
22 | - "*"
23 |
--------------------------------------------------------------------------------
/.github/workflows/auto-merge-dependabot.yml:
--------------------------------------------------------------------------------
1 | name: Auto-merge Dependabot PR
2 |
3 | on: [pull_request_target]
4 |
5 | permissions:
6 | pull-requests: write
7 | contents: write
8 |
9 | jobs:
10 | auto-merge:
11 | if: ${{ github.event.pull_request.user.login == 'dependabot[bot]' && github.repository == 'scala-steward-org/scala-steward-action' }}
12 | runs-on: ubuntu-latest
13 | steps:
14 | - name: Auto-merge Dependabot PRs
15 | env:
16 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
17 | PR_URL: ${{ github.event.pull_request.html_url }}
18 | run: gh pr merge --auto --squash "$PR_URL"
19 |
--------------------------------------------------------------------------------
/.github/workflows/ci.yml:
--------------------------------------------------------------------------------
1 | name: CI
2 |
3 | on: [pull_request]
4 |
5 | jobs:
6 | ci:
7 | runs-on: ubuntu-latest
8 | steps:
9 | - name: Checkout project
10 | uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
11 |
12 | - uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
13 | with:
14 | node-version: '20'
15 |
16 | - name: Run `npm install`
17 | run: npm install
18 |
19 | - name: Run `npm run all`
20 | run: npm run all
21 |
22 | - name: Save PR number
23 | if: ${{ github.event.pull_request.user.login != 'dependabot[bot]' }}
24 | run: echo ${{ github.event.number }} > PR_NUMBER
25 |
26 | - name: Upload artifact with `PR_NUMBER`
27 | if: ${{ github.event.pull_request.user.login != 'dependabot[bot]' }}
28 | uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
29 | with:
30 | name: PR_NUMBER
31 | path: PR_NUMBER
32 |
33 | - name: Upload artifact with `dist` folder
34 | if: ${{ github.event.pull_request.user.login != 'dependabot[bot]' }}
35 | uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
36 | with:
37 | name: dist
38 | path: dist/
39 |
40 | - name: Upload artifact with `covertura.xml`
41 | if: ${{ github.event.pull_request.user.login != 'dependabot[bot]' }}
42 | uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
43 | with:
44 | name: cobertura
45 | path: coverage/cobertura-coverage.xml
46 |
--------------------------------------------------------------------------------
/.github/workflows/code_coverage_comment.yml:
--------------------------------------------------------------------------------
1 | name: Add comment with code-coverage to PR
2 |
3 | on:
4 | workflow_run:
5 | workflows: ['CI']
6 | branches-ignore: ['dependabot/**']
7 | types: [completed]
8 |
9 | jobs:
10 | add-comment-with-code-coverage:
11 | runs-on: ubuntu-latest
12 | if: ${{ github.event.pull_request.user.login != 'dependabot[bot]' && github.event.workflow_run.conclusion == 'success' }}
13 | steps:
14 | - name: Checkout project
15 | uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
16 |
17 | - name: Download cobertura.xml file
18 | uses: dawidd6/action-download-artifact@07ab29fd4a977ae4d2b275087cf67563dfdf0295 # v9
19 | with:
20 | run_id: ${{github.event.workflow_run.id }}
21 | name: cobertura
22 | path: .
23 |
24 | - name: Download PR_NUMBER
25 | uses: dawidd6/action-download-artifact@07ab29fd4a977ae4d2b275087cf67563dfdf0295 # v9
26 | with:
27 | run_id: ${{github.event.workflow_run.id }}
28 | name: PR_NUMBER
29 | path: .
30 |
31 | - name: Extract PR number
32 | id: extract-pr-number
33 | run: |
34 | pr_number=$(cat ./PR_NUMBER)
35 | echo "PR_NUMBER=$pr_number" >> $GITHUB_OUTPUT
36 |
37 | - name: Code Coverage Report
38 | uses: irongut/CodeCoverageSummary@51cc3a756ddcd398d447c044c02cb6aa83fdae95 # v1.3.0
39 | with:
40 | filename: cobertura-coverage.xml
41 | badge: true
42 | format: markdown
43 | output: both
44 | thresholds: '60 80'
45 |
46 | - name: Add Coverage PR Comment
47 | uses: marocchino/sticky-pull-request-comment@52423e01640425a022ef5fd42c6fb5f633a02728 # v2.9.1
48 | with:
49 | recreate: true
50 | header: coverage
51 | number: ${{ steps.extract-pr-number.outputs.PR_NUMBER }}
52 | path: code-coverage-results.md
53 |
--------------------------------------------------------------------------------
/.github/workflows/release_auto.yml:
--------------------------------------------------------------------------------
1 | # Releases a new minor version every time a PR is merged into `master`.
2 | #
3 | # It also generates the `dist` folder inside the tag's commit, keeping
4 | # the `master` branch clean.
5 | #
6 | # It will also update the major tag v2 to track the latest tag.
7 |
8 | name: Release new version
9 |
10 | on:
11 | workflow_dispatch:
12 | push:
13 | branches:
14 | - master
15 |
16 | jobs:
17 | new-release:
18 | name: Create new release
19 | runs-on: ubuntu-latest
20 | steps:
21 | - name: Checkout project
22 | uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
23 | with:
24 | fetch-depth: 0
25 | ref: master
26 |
27 | - uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
28 | with:
29 | node-version: '20'
30 |
31 | - name: Run `npm install`
32 | run: npm install
33 |
34 | - name: Run `npm run build`
35 | run: npm run build
36 |
37 | - name: Release new version
38 | uses: int128/release-typescript-action@f30250a9bb537e3a541f581122deb035080e8f68 # v1.35.0
39 | with:
40 | major-version: 2
41 |
42 | update-docs:
43 | name: Update documentation
44 | if: ${{ github.actor != 'dependabot[bot]' }}
45 | runs-on: ubuntu-latest
46 | steps:
47 | - name: Checkout project
48 | uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
49 | with:
50 | fetch-depth: 0
51 | ref: master
52 |
53 | - name: Run `npm install`
54 | run: npm install
55 |
56 | - name: Run `npm run docs`
57 | run: npm run docs
58 |
59 | - name: Commit changes by `npm run docs`
60 | uses: alejandrohdezma/actions/commit-and-push@v1
61 | with:
62 | message: Run `npm run docs` [skip ci]
63 | branch: master
64 |
--------------------------------------------------------------------------------
/.github/workflows/release_pr_snapshot.yml:
--------------------------------------------------------------------------------
1 | name: Release a snapshot artifact for a PR
2 |
3 | on:
4 | workflow_run:
5 | workflows: ['CI']
6 | branches-ignore: ['dependabot/**']
7 | types: [completed]
8 |
9 | jobs:
10 | release-snapshot-artifact:
11 | runs-on: ubuntu-latest
12 | if: ${{ github.event.pull_request.user.login != 'dependabot[bot]' && github.event.workflow_run.conclusion == 'success' }}
13 | steps:
14 | - name: Download PR_NUMBER
15 | uses: dawidd6/action-download-artifact@07ab29fd4a977ae4d2b275087cf67563dfdf0295 # v9
16 | with:
17 | run_id: ${{github.event.workflow_run.id }}
18 | name: PR_NUMBER
19 | path: .
20 |
21 | - name: Extract PR number
22 | id: extract-pr-number
23 | run: |
24 | pr_number=$(cat ./PR_NUMBER)
25 | echo "PR_NUMBER=$pr_number" >> $GITHUB_OUTPUT
26 |
27 | - name: Checkout project
28 | uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
29 |
30 | - name: Checkout PR
31 | env:
32 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
33 | run: gh pr checkout ${{ steps.extract-pr-number.outputs.PR_NUMBER }}
34 |
35 | - name: Download dist folder
36 | uses: dawidd6/action-download-artifact@07ab29fd4a977ae4d2b275087cf67563dfdf0295 # v9
37 | with:
38 | run_id: ${{github.event.workflow_run.id }}
39 | name: dist
40 | path: dist
41 |
42 | - name: Remove `dist` from `.gitignore`
43 | run: sed -i -E 's|^/?dist/?||g' .gitignore
44 |
45 | - name: Create snapshot branch
46 | uses: alejandrohdezma/actions/commit-and-push@v1
47 | with:
48 | message: 'Release snapshot for #${{ steps.extract-pr-number.outputs.PR_NUMBER }}'
49 | force-push: 'true'
50 | branch: snapshots/${{ steps.extract-pr-number.outputs.PR_NUMBER }}
51 |
52 | - name: Create Comment
53 | uses: marocchino/sticky-pull-request-comment@52423e01640425a022ef5fd42c6fb5f633a02728 # v2.9.1
54 | with:
55 | recreate: true
56 | header: snapshot
57 | number: ${{ steps.extract-pr-number.outputs.PR_NUMBER }}
58 | message: |
59 | A snapshot release has been created as `snapshots/${{ steps.extract-pr-number.outputs.PR_NUMBER }}`.
60 |
61 | You can test it out with:
62 |
63 | ```yaml
64 | uses: scala-steward-org/scala-steward-action@snapshots/${{ steps.extract-pr-number.outputs.PR_NUMBER }}
65 | ```
66 |
67 | It will be automatically recreated on any change to this PR.
68 |
--------------------------------------------------------------------------------
/.github/workflows/remove_snapshot_branch.yml:
--------------------------------------------------------------------------------
1 | name: Remove snapshot branch
2 |
3 | on:
4 | pull_request_target:
5 | types:
6 | - closed
7 |
8 | jobs:
9 | delete-pr-branch:
10 | runs-on: ubuntu-latest
11 | if: github.event.sender.login != 'dependabot[bot]'
12 | steps:
13 | - name: Checkout project
14 | uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
15 |
16 | - name: Remove snapshot branch
17 | run: git push origin -d snapshots/${{ github.event.number }} || true
18 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Dependency directory
2 | node_modules
3 |
4 | # Rest pulled from https://github.com/github/gitignore/blob/master/Node.gitignore
5 | # Logs
6 | logs
7 | *.log
8 | npm-debug.log*
9 | yarn-debug.log*
10 | yarn-error.log*
11 | lerna-debug.log*
12 |
13 | # Diagnostic reports (https://nodejs.org/api/report.html)
14 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
15 |
16 | # Runtime data
17 | pids
18 | *.pid
19 | *.seed
20 | *.pid.lock
21 |
22 | # Directory for instrumented libs generated by jscoverage/JSCover
23 | lib-cov
24 |
25 | # Coverage directory used by tools like istanbul
26 | coverage
27 | *.lcov
28 |
29 | # nyc test coverage
30 | .nyc_output
31 |
32 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
33 | .grunt
34 |
35 | # Bower dependency directory (https://bower.io/)
36 | bower_components
37 |
38 | # node-waf configuration
39 | .lock-wscript
40 |
41 | # Compiled binary addons (https://nodejs.org/api/addons.html)
42 | build/Release
43 |
44 | # Dependency directories
45 | jspm_packages/
46 |
47 | # TypeScript v1 declaration files
48 | typings/
49 |
50 | # TypeScript cache
51 | *.tsbuildinfo
52 |
53 | # Optional npm cache directory
54 | .npm
55 |
56 | # Optional eslint cache
57 | .eslintcache
58 |
59 | # Optional REPL history
60 | .node_repl_history
61 |
62 | # Output of 'npm pack'
63 | *.tgz
64 |
65 | # Yarn Integrity file
66 | .yarn-integrity
67 |
68 | # dotenv environment variables file
69 | .env
70 | .env.test
71 |
72 | # parcel-bundler cache (https://parceljs.org/)
73 | .cache
74 |
75 | # next.js build output
76 | .next
77 |
78 | # nuxt.js build output
79 | .nuxt
80 |
81 | # vuepress build output
82 | .vuepress/dist
83 |
84 | # Serverless directories
85 | .serverless/
86 |
87 | # FuseBox cache
88 | .fusebox/
89 |
90 | # DynamoDB Local files
91 | .dynamodb/
92 |
93 | # OS metadata
94 | .DS_Store
95 | Thumbs.db
96 |
97 | # Ignore built ts files
98 | __tests__/runner/*
99 | lib/**/*
100 |
101 | # Ignore IntelliJ IDEA files
102 | .idea
103 |
104 | # Ignore Visual Studio Code files
105 | .vscode
106 |
107 | # Ignore `dist` folder, it is generated only inside tag's commits
108 | dist
109 |
110 | # Ignore coverage folder generated by `c8`
111 | coverage
112 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Code of Conduct
2 |
3 | We are committed to providing a friendly, safe and welcoming environment for
4 | all, regardless of level of experience, gender, gender identity and expression,
5 | sexual orientation, disability, personal appearance, body size, race, ethnicity,
6 | age, religion, nationality, or other such characteristics.
7 |
8 | Everyone is expected to follow the [Scala Code of Conduct](https://www.scala-lang.org/conduct/)
9 | when discussing the project on the available communication channels. If you are being harassed, please
10 | contact us immediately so that we can support you.
11 |
12 | ## Moderation
13 |
14 | For any questions, concerns, or moderation requests please contact a member of the project.
15 |
16 | - [Alejandro Hernández](mailto:info@alejandrohdezma.com)
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright 2020 Alejandro Hernández
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Scala Steward GitHub Action
2 |
3 | A GitHub Action to launch [Scala Steward](https://github.com/scala-steward-org/scala-steward) in your repository.
4 |
5 |
6 |
7 | - [Installation](#installation)
8 | - [Simple workflow using default GitHub Actions App](#simple-workflow-using-default-github-actions-app)
9 | - [Workflow with a custom GitHub App to manage multiple repositories](#workflow-with-a-custom-github-app-to-manage-multiple-repositories)
10 | - [Usage](#usage)
11 | - [Guides](#guides)
12 | - [Contributors](#contributors)
13 |
14 |
15 |
16 | ---
17 |
18 | ## Installation
19 |
20 | You can use this action for [individual repositories](#simple-workflow-using-default-github-actions-app) or you can configure a repository to [manage many repositories](#workflow-with-a-custom-github-app-to-manage-multiple-repositories).
21 |
22 | ### Simple workflow using default GitHub Actions App
23 |
24 | ```yaml
25 | on:
26 | schedule:
27 | - cron: '0 0 * * 0'
28 |
29 | name: Scala Steward
30 |
31 | permissions:
32 | contents: write
33 | pull-requests: write
34 |
35 | jobs:
36 | scala-steward:
37 | runs-on: ubuntu-latest
38 | name: Scala Steward
39 | steps:
40 | - name: Scala Steward
41 | uses: scala-steward-org/scala-steward-action@v2
42 | ```
43 |
44 | See [Usage](#usage)
45 |
46 | Note that you won't be able to use any of `github-app-*`, `repos-file`, or `github-repository` inputs as the GitHub Actions App can only possibly write to the current repository.
47 |
48 | You will also need to ensure that GitHub Actions has permissions to create and approve pull requests for the [organization](https://docs.github.com/en/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#preventing-github-actions-from-creating-or-approving-pull-requests) or [repository](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#preventing-github-actions-from-creating-or-approving-pull-requests).
49 |
50 |
51 | ### Workflow with a custom GitHub App to manage multiple repositories
52 |
53 | To use the Action in your repo, you need to create a GitHub App. Then you need to create a new GitHub Actions workflow file to run this Action. Here is a step-by-step tutorial on how to do it:
54 |
55 | 1. Create a new GitHub App
56 |
57 | If you are creating a GitHub App for your personal account, just click [here][github-app-personal] and it will create one with the base settings already pre-configured.
58 |
59 | On the other hand, if you are creating the App for an organization account, copy [this url][github-app-organization] and replace `my_org` with the name of your organization.
60 |
61 | > You will need to rename the App's name to a handler that is not already taken. You can use `scala-steward-{my-github-login}` if you are creating the app for your personal account; otherwise, you can use `scala-steward-{my-org}`.
62 |
63 | Alternatively, you can follow the official guide for creating a GitHub App :point_down:
64 |
65 | Official guide
66 |
67 | Follow the GitHub's [Creating a GitHub App](https://docs.github.com/en/developers/apps/building-github-apps/creating-a-github-app) Guide.
68 |
69 | 1. If you're setting up this Action for an organisation-owned repo, note that the step (1) of the "Creating a GitHub App" Guide tells you how to create an organization-level App.
70 | 2. Step (7) of the Guide tells you to specify the homepage – you can write a random URL there.
71 | 3. Step (13) of the Guide tells you to specify the Webhook URL - you don't need it. Uncheck the box.
72 | 4. Step (15) of the Guide asks you which permissions you want your app to have. Specify the following:
73 | - Metadata: Read-only
74 | - Pull requests: Read and write
75 | - Contents: Read and write
76 |
77 |
78 |
79 | Optional: Upload a profile picture for the newly created App.
80 |
81 | 1. Locate the newly created App's Settings. To do so, go to the settings of either your personal profile or of that of your organisation (depending on where you created the App), select "Developer Settings" from the side bar, then click "GitHub Apps". Find your app, and click "Edit" next to it.
82 | - To access your personal settings, click on your profile icon at the top-right corner of the GitHub interface, click "Settings".
83 | - To access the settings of an organisation, click on your profile icon at the top-right, select "Your organizations", find the organisation for which you created an App and click "Settings" for that organisation.
84 | 2. In the settings, locate the "Display information" section and press the "Upload a logo" button.
85 | 3. If you want to use [Scala Steward's official logo](https://github.com/scala-steward-org/scala-steward/raw/main/data/images/scala-steward-logo-circle-0.png) just download it to a folder in your computer and upload it back using the input. Then set "Badge background color" to `#3d5a80`
86 |
87 | 2. Install the App
90 |
91 | 1. At the App Settings, at the sidebar, click the "Public page" button, there, click the green "Install" button.
92 | 2. Select whether you'd like to install it account-wide or only for selected repos. If you install it for your entire account (personal or organisation), Scala Steward will try to update every repository in your organization, even if they're not Scala repositories.
93 | 3. Click "Install".
94 | 4. When the new page opens, find its URL and copy the number behind `https://github.com/settings/installations/`. It is the installation ID, you will need it in the following step.
95 |
96 | 3. Copy the App ID, the App private key and the installation ID
99 |
100 | Locate the App ID, the installation ID and the App private key for usage in the next step of this tutorial. All of them can be accessed from your App's Settings.
101 |
102 | 1. App ID is available in the "About" section of the Settings.
103 | 2. You should have the installation ID from step (2.4). If you didn't copy it, go to the App's settings and click on "Install App" on the left. On the new page you should see the account where you install the app. Click the "gear" icon on the right. When the next page loads, find its URL and copy the number behind `https://github.com/settings/installations/`. That's the installation ID.
104 | 3. The private key needs to be generated from the "Private keys" section. Clicking the "Generate private key" button will download a `*.pem` file on your computer. Save that file for the following step.
105 |
106 | 4. Create repo secrets
109 |
110 | Create repo secrets for the private key, the app id and the installation ID in the repository from where you want to run this action.
111 |
112 | 1. To do so, from the repo's page, click the "Settings" tab. There, select "Secrets" at the sidebar, and click "Actions" at the dropdown menu. Click "New repository secret".
113 | 2. At the "Name" field, enter `APP_PRIVATE_KEY`. Then, open the ".pem" file you downloaded at step (3.3) with a text editor, and copy the contents. Make sure to copy everything, including the first line `-----BEGIN RSA PRIVATE KEY-----` and the last line `-----END RSA PRIVATE KEY-----`. Paste it at the "Value" text area. Click "Add Secret".
114 | 3. Repeat the previous steps (4.1) to add a secret for the app id you recover on step (3.1). Specify `APP_ID` as the name.
115 | 4. Repeat the previous steps (4.1) to add a secret for the installation id you recover on step (3.2). Specify `APP_INSTALLATION_ID` as the name.
116 |
117 | 5. Create a new GitHub Actions Workflow
120 |
121 | Create a new GitHub Actions Workflow file, e.g. `.github/workflows/scala-steward.yml`, in the repo where you're installing this Action. Paste the following content into that file:
122 |
123 | ```yaml
124 | on:
125 | schedule:
126 | - cron: '0 0 * * 0'
127 |
128 | name: Launch Scala Steward
129 |
130 | jobs:
131 | scala-steward:
132 | runs-on: ubuntu-latest
133 | name: Launch Scala Steward
134 | steps:
135 | - name: Launch Scala Steward
136 | uses: scala-steward-org/scala-steward-action@v2
137 | with:
138 | github-app-id: ${{ secrets.APP_ID }}
139 | github-app-installation-id: ${{ secrets.APP_INSTALLATION_ID }}
140 | github-app-key: ${{ secrets.APP_PRIVATE_KEY }}
141 | ```
142 |
143 | 6. Scala Steward does its magic :tada:
146 |
147 | If you have used the default cron expression the workflow will launch at 00:00 every Sunday. If you want to change it to a different schedule, you can check [this page](https://crontab.guru).
148 |
149 | When it launches it will send PR to update all the repos selected in step (2.2).
150 |
151 | Manually triggering a run
316 |
317 | You can manually trigger workflow runs using the [workflow_dispatch](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#workflow_dispatch) event:
318 |
319 | ```diff
320 | on:
321 | + workflow_dispatch:
322 | schedule:
323 | - cron: '0 0 * * 0'
324 |
325 | name: Launch Scala Steward
326 |
327 | jobs:
328 | scala-steward:
329 | runs-on: ubuntu-latest
330 | name: Launch Scala Steward
331 | steps:
332 | - name: Launch Scala Steward
333 | uses: scala-steward-org/scala-steward-action@v2
334 | with:
335 | github-app-id: ${{ secrets.APP_ID }}
336 | github-app-installation-id: ${{ secrets.APP_INSTALLATION_ID }}
337 | github-app-key: ${{ secrets.APP_PRIVATE_KEY }}
338 | ```
339 | Once you've added this trigger GitHub will show a "Run workflow" button at the workflow page.
340 |
341 |
342 | Specify JVM version
345 |
346 | If you would like to specify a specific Java version (e.g Java 11) please add the following step before `Launch Scala Steward` step:
347 |
348 | ```yaml
349 | - name: Set up JDK 11
350 | uses: actions/setup-java@v3
351 | with:
352 | java-version: 11
353 | distribution: temurin
354 | ```
355 |
356 |
357 | Add JVM options to the running JVM
360 |
361 | If you would like to add JVM options (such as `-Xmx`) to the Scala Steward JVM process please add the following to the main `Launch Scala Steward` step:
362 |
363 | ```yaml
364 | - name: Launch Scala Steward
365 | uses: scala-steward-org/scala-steward-action@v2
366 | env:
367 | JAVA_OPTS: "-XX:+UseG1GC -Xms4G -Xmx4G -Xss2M -XX:MetaspaceSize=512M"
368 | ```
369 |
370 |
371 | Updating a specific repository
374 |
375 | When using the `github-app-*` inputs, Scala Steward will always retrieve the list of repositories to update from the App's installation. You can override this by setting `github-app-auth-only` to `'true'`. This way the action will only use the app credentials to authenticate and will update the repository set on the `github-repository` input (defaults to the current repository).
376 |
377 | ```yaml
378 | on:
379 | schedule:
380 | - cron: '0 0 * * 0'
381 |
382 | name: Launch Scala Steward
383 |
384 | jobs:
385 | scala-steward:
386 | runs-on: ubuntu-latest
387 | name: Launch Scala Steward
388 | steps:
389 | - name: Launch Scala Steward
390 | uses: scala-steward-org/scala-steward-action@v2
391 | with:
392 | github-app-id: ${{ secrets.APP_ID }}
393 | github-app-installation-id: ${{ secrets.APP_INSTALLATION_ID }}
394 | github-app-key: ${{ secrets.APP_PRIVATE_KEY }}
395 | github-app-auth-only: 'true'
396 | ```
397 |
398 | To update a repository other than the one where the Action runs, we can override the `github-repository` input. Just set it to the name (owner/repo) of the repository you would like to update.
399 |
400 | ```yaml
401 | - name: Launch Scala Steward
402 | uses: scala-steward-org/scala-steward-action@v2
403 | with:
404 | github-app-id: ${{ secrets.APP_ID }}
405 | github-app-installation-id: ${{ secrets.APP_INSTALLATION_ID }}
406 | github-app-key: ${{ secrets.APP_PRIVATE_KEY }}
407 | github-app-auth-only: 'true'
408 | github-repository: owner/repo
409 | ```
410 |
411 |
412 | Update specific repositories (listed on a file)
415 |
416 | When using the `github-app-*` inputs, Scala Steward will always retrieve the list of repositories to update from the App's installation. You can override this by setting `github-app-auth-only` to `'true'`. This way the action will only use the app credentials to authenticate and will allow other mechanisms for selecting which repository should be updated. For example, you can specify a list of repositories in a markdown file.
417 |
418 | 1. Create a file containing the list of repositories in markdown format:
419 | ```markdown
420 | # repos.md
421 | - owner/repo_1
422 | - owner/repo_2
423 | ```
424 | 2. Put that file inside the repository directory (so it is accessible to Scala Steward's action).
425 | 3. Provide it to the action using `repos-file`:
426 | ```yaml
427 | - name: Checkout repository so `repos.md` is available
428 | uses: actions/checkout@v2
429 |
430 | - name: Launch Scala Steward
431 | uses: scala-steward-org/scala-steward-action@v2
432 | with:
433 | github-app-id: ${{ secrets.APP_ID }}
434 | github-app-installation-id: ${{ secrets.APP_INSTALLATION_ID }}
435 | github-app-key: ${{ secrets.APP_PRIVATE_KEY }}
436 | github-app-auth-only: 'true'
437 | repos-file: 'repos.md'
438 | ```
439 |
440 | >
441 |
442 | > This input (if present) will always take precedence over `github-repository`.
443 |
444 |
445 | Update one or more specific branches
448 |
449 | > **Important!** This input is only used when using the `github-repository` input (see the "Updating a specific repository" guide). For cases where the `repos-file` input is used (see the "Update specific repositories (listed on a file)" guide), you should follow the [instructions to update multiple branches in a repository](https://github.com/scala-steward-org/scala-steward/blob/main/docs/faq.md#can-scala-steward-update-multiple-branches-in-a-repository).
450 |
451 | > **This input won't have any effect when using a GitHub App for listing the repositories to update.**
452 |
453 | By default, Scala Steward uses the repository's default branch to make the updates. If you want to customize that behavior, you can use the `branches` input:
454 |
455 | ```yml
456 | - name: Launch Scala Steward
457 | uses: scala-steward-org/scala-steward-action@v2
458 | with:
459 | github-app-id: ${{ secrets.APP_ID }}
460 | github-app-installation-id: ${{ secrets.APP_INSTALLATION_ID }}
461 | github-app-key: ${{ secrets.APP_PRIVATE_KEY }}
462 | github-app-auth-only: 'true'
463 | github-repository: owner/repo
464 | branches: main,0.1.x,0.2.x
465 | ```
466 |
467 |
468 | Disable ignoring OPTS files
471 |
472 | By default, Scala Steward will ignore "opts" files (such as `.jvmopts` or `.sbtopts`) when found on repositories, if you want to disable this feature, use the `ignore-opts-files` input:
473 |
474 | ```yaml
475 | - name: Launch Scala Steward
476 | uses: scala-steward-org/scala-steward-action@v2
477 | with:
478 | github-app-id: ${{ secrets.APP_ID }}
479 | github-app-installation-id: ${{ secrets.APP_INSTALLATION_ID }}
480 | github-app-key: ${{ secrets.APP_PRIVATE_KEY }}
481 | ignore-opts-files: false
482 | ```
483 |
484 |
485 | Run Scala Steward with step debug logging
488 |
489 | You just need to enable [GitHub Actions' "step debug logging"](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging#enabling-step-debug-logging) and Scala Steward will start automatically in debug mode too.
490 |
491 | For this you must set the following secret in the repository that contains the workflow: `ACTIONS_STEP_DEBUG` to `true` (as stated in GitHub's documentation).
492 |
493 | > Alternatively, if you are re-running a failed job and want to re-run it in debug
494 | > mode, follow this tutorial and check `Enable debug logging` before clicking on
495 | > `Re-run jobs`.
496 | >
497 | > 
498 |
499 |
500 | Running locally to attach a JVM debugger
503 |
504 | When debugging the behaviour of Scala Steward, it can be helpful to run Scala Steward
505 | locally, while mimicking the settings used by the Scala Steward GitHub Action, so that
506 | a debugger can be attached - [the Guardian have notes on how they do that](https://github.com/guardian/scala-steward-public-repos/blob/main/running-locally.md),
507 | which may provide a helpful example if you need to do that in your own organisation.
508 |
509 |
510 | Using a Personal Access Token (instead of the GitHub App)
513 |
514 | If for any reason you want to use the default GitHub Token available in GitHub Actions, you won't be able to use the `github-app-*` inputs. If you still want to use it you just need to remove all the `github-app-*` inputs and follow these steps:
515 |
516 | 1. Generate a [GitHub Personal Access Token](https://github.com/settings/tokens) with `repo` permissions for reading/writing in the repository/repositories you wish to update.
517 | 2. Add it as a repository secret.
518 | 3. Follow either the `Updating a specific repository` or the `Update specific repositories (listed on a file)` guides to provide a repository to update.
519 | 3. Provide the token to the action using the `github-token` input.
520 |
521 | **Example updating the current repository with the default GitHub Token**
522 |
523 | ```yaml
524 | - name: Launch Scala Steward
525 | uses: scala-steward-org/scala-steward-action@v2
526 | with:
527 | github-token: ${{ secrets.REPO_GITHUB_TOKEN }}
528 | ```
529 |
530 | **Example updating a specific repository with the default GitHub Token**
531 |
532 | ```yaml
533 | - name: Launch Scala Steward
534 | uses: scala-steward-org/scala-steward-action@v2
535 | with:
536 | github-repository: owner/repo
537 | github-token: ${{ secrets.REPO_GITHUB_TOKEN }}
538 | ```
539 |
540 | **Example updating a list of repositories (from a file) with the default GitHub Token**
541 |
542 | ```yaml
543 | - name: Launch Scala Steward
544 | uses: scala-steward-org/scala-steward-action@v2
545 | with:
546 | github-repository: owner/repo
547 | github-token: ${{ secrets.REPO_GITHUB_TOKEN }}
548 | repos-file: 'repos.md'
549 | ```
550 |
551 | Beware that using the Personal Access Token will make it look like it's you who submitted all the PRs. The workaround for this is to create a separate GitHub account for the Action and give it the [Collaborator](https://help.github.com/en/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository) permission in the repository or repositories you wish to update.
552 |
553 | Make sure the account you choose has *Name* and *Public email* fields defined in its [Public Profile](https://github.com/settings/profile), as they will be used by Scala Steward to make commits.
554 |
555 | If the account has [personal email address protection](https://help.github.com/en/github/setting-up-and-managing-your-github-user-account/blocking-command-line-pushes-that-expose-your-personal-email-address) enabled, then you will need to explicitly specify an email to use in commits:
556 |
557 | ```yaml
558 | - name: Launch Scala Steward
559 | uses: scala-steward-org/scala-steward-action@v2
560 | with:
561 | github-token: ${{ secrets.REPO_GITHUB_TOKEN }}
562 | author-email: 12345+octocat@users.noreply.github.com
563 | ```
564 |
565 |
566 | Sign commits created by Scala Steward
569 |
570 | > Signing commits only take place when using a GitHub Personal Access Token (see the "Using a Personal Access Token (instead of the GitHub App)" guide).
571 |
572 | If you want commits created by Scala Steward to be automatically signed with a GPG key, follow these steps:
573 |
574 | 1. Generate a new GPG key following [GitHub's own tutorial](https://help.github.com/en/github/authenticating-to-github/generating-a-new-gpg-key).
575 | 2. Add your new GPG key to your [user's GitHub account](https://github.com/settings/keys) following [GitHub's own tutorial](https://help.github.com/en/github/authenticating-to-github/adding-a-new-gpg-key-to-your-github-account).
576 | 3. Export the GPG private key as an ASCII armored version to your clipboard (change `joe@foo.bar` with your key email address):
577 |
578 | ```bash
579 | # macOS
580 | gpg --armor --export-secret-key joe@foo.bar | pbcopy
581 |
582 | # Ubuntu (assuming GNU base64)
583 | gpg --armor --export-secret-key joe@foo.bar -w0 | xclip
584 |
585 | # Arch
586 | gpg --armor --export-secret-key joe@foo.bar | sed -z 's;\n;;g' | xclip -selection clipboard -i
587 |
588 | # FreeBSD (assuming BSD base64)
589 | gpg --armor --export-secret-key joe@foo.bar | xclip
590 | ```
591 |
592 | 4. Paste your clipboard as a new `GPG_PRIVATE_KEY` repository secret.
593 | 5. If the key is passphrase protected, add the passphrase as another repository secret called `GPG_PASSPHRASE`.
594 | 6. Import it to the workflow using an action such us [crazy-max/ghaction-import-gpg](https://github.com/crazy-max/ghaction-import-gpg):
595 |
596 | ```yaml
597 | - name: Import GPG key
598 | uses: crazy-max/ghaction-import-gpg@v2
599 | with:
600 | git_user_signingkey: true
601 | env:
602 | GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
603 | PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
604 | ```
605 |
606 | 7. Obtain the key ID for the key that should be used. For instance, in the following example, the GPG key ID is `3AA5C34371567BD2`:
607 |
608 | ```
609 | $ gpg --list-secret-keys --keyid-format=long
610 |
611 | ~/.gnupg/secring.gpg
612 | ------------------------------------
613 | sec 4096R/3AA5C34371567BD2 2022-01-01
614 | uid My Name
615 | ssb 4096R/42B317FD4BA89E7A 2022-01-01
616 | ```
617 |
618 | 8. Copy the key ID and paste it as the content of a new repository secret, named `GPG_SIGNING_KEY_ID`.
619 |
620 | 9. Tell Scala Steward to sign commits using the `sign-commits` input. Use as well the `signing-key` parameter to allow Scala Steward to use the correct key:
621 |
622 | ```yaml
623 | - name: Launch Scala Steward
624 | uses: scala-steward-org/scala-steward-action@v2
625 | with:
626 | github-token: ${{ secrets.REPO_GITHUB_TOKEN }}
627 | signing-key: ${{ secrets.GPG_SIGNING_KEY_ID }}
628 | sign-commits: true
629 | ```
630 |
631 | 10. **Optional**. By default, Scala Steward will use the email/name of the user that created the token added in `github-token`, if you want to override that behavior, you can use `author-email`/`author-name` inputs, for example with the values extracted from the imported private key:
632 |
633 | ```yaml
634 | - name: Import GPG key
635 | id: import_gpg
636 | uses: crazy-max/ghaction-import-gpg@v2
637 | with:
638 | git_user_signingkey: true
639 | env:
640 | GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
641 | PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
642 |
643 | - name: Launch Scala Steward
644 | uses: scala-steward-org/scala-steward-action@v2
645 | with:
646 | github-token: ${{ secrets.REPO_GITHUB_TOKEN }}
647 | signing-key: ${{ secrets.GPG_SIGNING_KEY_ID }}
648 | sign-commits: true
649 | author-email: ${{ steps.import_gpg.outputs.email }}
650 | author-name: ${{ steps.import_gpg.outputs.name }}
651 | ```
652 |
653 |
654 | 
