Skip to content

Commit c8228c8

Browse files
committed
Update CONTRIBUTING.md for revised GitHub workflows
1 parent ff10b3d commit c8228c8

File tree

1 file changed

+15
-23
lines changed

1 file changed

+15
-23
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,8 @@ This workflow will run if:
349349
* any tag is created
350350
* requested
351351

352-
The workflow has two jobs: `integration-tests` and `github-release`.
352+
The workflow has three jobs: `integration-tests`, `linux-arm64` and
353+
`github-release`.
353354

354355
The `integration-tests` job runs on a matrix of operating systems (`ubuntu`,
355356
`windows` and `macos`) and makes use of the `release.hs` script at
@@ -363,36 +364,27 @@ Its 'Build bindist' step uses `release.hs build`.
363364
Its 'Upload bindist' step uploads artifacts using the name of the runner's
364365
operating system (`Linux`, `Windows` or `macOS`) as the name for the artifacts.
365366

366-
The `github-release` job needs `integration-tests` and only takes effect if the
367-
trigger for the workflow was the creation of a tag.
367+
The `linux-arm64` job runs on a self-hosted runner for Linux and ARM64. It makes
368+
use of Docker and a Docker file at `etc/dockerfiles/arm64.Dockerfile`.
368369

369-
Its steps `Download Linux/Windows/macOS artifact` download the named artifacts
370-
to path `_release`.
370+
Its 'Build bindist' step makes use of a compiled version of `release.hs` script
371+
at `etc/scripts` to command `release build`.
372+
373+
Its 'Upload bindist' step uploads artifacts using `Linux-ARM64` as the name for
374+
the artifacts.
375+
376+
The `github-release` job needs `integration-tests` and `linux-arm64`. It only
377+
takes effect if the trigger for the workflow was the creation of a tag.
378+
379+
Its four steps `Download Linux/Windows/macOS/Linux-ARM64 artifact` download the
380+
named artifacts to path `_release`.
371381

372382
Its step 'Hash and sign assets' makes use of a 'secret' environment variable
373383
`RELEASE_SIGNING_KEY` established by the owner of the Stack repository. The
374384
variable contains the private key for the GPG key with ID 0x575159689BEFB442.
375385
That key is imported into GPG and then used by GPG to create a detached signture
376386
for each file.
377387

378-
### ARM64 (AArch64) release - `arm64-release.yml`
379-
380-
This workflow will run if:
381-
* there is a pull request
382-
* commits are pushed to these branches: `master`, `stable` and `rc/**`
383-
* any tag is created
384-
* requested
385-
386-
The workflow has one job (`arm64`). It runs on a self-hosted runner for Linux
387-
and ARM64. It makes use of Docker and a Docker file at
388-
`etc/dockerfiles/arm64.Dockerfile`.
389-
390-
Its 'Build bindist' step makes use of a compiled version of `release.hs` script
391-
at `etc/scripts` to command `release build`.
392-
393-
Its 'Upload bindist' step uploads artifacts using `Linux-ARM64` as the name for
394-
the artifacts.
395-
396388
### Inactive - `stan.yml`
397389

398390
Stan is a Haskell static analysis tool. As of 29 August 2022, it does not

0 commit comments

Comments
 (0)