Skip to content

Commit 3440884

Browse files
committed
Add some notes about running the Pelican GHA locally
1 parent 3661741 commit 3440884

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

develop/pelican-gha.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Pelican GHA
2+
3+
To test Pelican GitHub Actions, install [`act`](https://github.com/nektos/act). `act` is a Go program which runs GitHub Actions locally. You can [install it from Nix](https://search.nixos.org/packages?channel=unstable&show=act&from=0&size=50&sort=relevance&type=packages&query=act), from your preferred package manager, or from Go source.
4+
5+
You will need a GitHub PAT. Read the [instructions for issuing a fine-grained PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token). Get one from [your PAT settings page](https://github.com/settings/personal-access-tokens) once logged in to GitHub.
6+
7+
The PAT is necessary because the Pelican GHA reads from this repository. You will therefore need to issue a PAT which has public read access to all repositories. Choose a suitable expiry date; long expiries for read only PATs are probably fine.
8+
9+
Run the Pelican GHA using:
10+
11+
```shell
12+
DOCKER_HOST=unix:///.../docker.sock act \
13+
--container-architecture linux/amd64 \
14+
--container-daemon-socket - \
15+
-s GITHUB_TOKEN \
16+
push
17+
```
18+
19+
You don't need to specify the container architecture if you're already using `linux/amd64`.

0 commit comments

Comments
 (0)