Skip to content

Commit 9306439

Browse files
committed
Add info about CI's approach to creating a cache
Also corrects a broken link.
1 parent 06ee0ed commit 9306439

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -335,6 +335,12 @@ The `unit-tests` job runs on a matrix of operating systems and Stack
335335
project-level YAML configuration files (`stack.yaml`). It builds and tests Stack
336336
with the following flags: `--haddock --no-haddock-deps`.
337337

338+
Its approach to creating a cache depends on the operating system. Its 'Cache
339+
dependencies on Unix-like OS' step caches the Stack root on Unix-like operating
340+
systems. Its 'Cache dependencies on Windows' step caches the same information
341+
on Windows, but takes into account that a relevant directory is located outside
342+
of the Stack root.
343+
338344
### Integration-based - `intergration-tests.yml`
339345

340346
This workflow will run if:
@@ -347,7 +353,8 @@ The workflow has two jobs: `integration-tests` and `github-release`.
347353

348354
The `integration-tests` job runs on a matrix of operating systems (`ubuntu`,
349355
`windows` and `macos`) and makes use of the `release.hs` script at
350-
`etc/scripts`.
356+
`etc/scripts`. Its approach to creating a cache is the same as for
357+
`unit-tests.yml`, described above.
351358

352359
Its 'Install deps and run checks' step uses `release.hs check`.
353360

doc/GUIDE_advanced.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ documentation.
368368

369369
The Stack repository uses GitHub Actions for its own CI. For further
370370
information, see the guide to
371-
[contributing](CONTRIBUTING.md#Continuous-integration-(CI)).
371+
[contributing](CONTRIBUTING.md#continuous-integration-ci).
372372

373373
### Azure
374374

0 commit comments

Comments
 (0)