push to a tangled.sh mirror (mirrored from github of course)
📝 Add quickstart section in README
authored by
GitHub
b9825bff
76b16091
+47
README.md
+47
README.md
···
9
9
| knot | hostname of the tangled knot used | tangled.sh |
10
10
| ssh-key | contents of a private ssh key that has push access to the repo | (required) | `-----BEGIN OPENSSH PRIVATE KEY-----\n you really thought, huh? \n-----END OPENSSH PRIVATE KEY-----`
11
11
12
+
## Quickstart
13
+
14
+
1. Create a secret named `TANGLED_KEY` that has your SSH private key
15
+
16
+
Quick copy if you've created a key with just `ssh-keygen` without any flags:
17
+
18
+
(linux)
19
+
20
+
```
21
+
wl-copy < ~/.ssh/id_ed25519
22
+
```
23
+
24
+
(mac os)
25
+
26
+
```
27
+
pbcopy < ~/.ssh/id_ed25519
28
+
```
29
+
30
+
(wind*ws)
31
+
32
+
```
33
+
cat ~/.ssh/id_ed25519 > clip.exe
34
+
```
35
+
36
+
Go to your github repo's settings > secrets > actions > repository secrets
37
+
38
+
2. Create the tangled.sh repo (for now, you have to do it manually beforehand)
39
+
40
+
3. Just put ~~the fries in the bag~~ this in `.github/workflows/tangle.yml`
41
+
42
+
```yaml
43
+
name: Tangle
44
+
45
+
on:
46
+
push: {}
47
+
workflow_dispatch: {}
48
+
49
+
jobs:
50
+
tangle:
51
+
runs-on: ubuntu-latest
52
+
steps:
53
+
- uses: gwennlbh/to-tangled@v0.3
54
+
with:
55
+
repo: yourself.bsky.social/your-repo
56
+
ssh-key: ${{ secrets.TANGLED_KEY }}
57
+
```
58
+
12
59
## How?
13
60
14
61
The action clones your repo, sets up the ssh key, adds the knot as a git remote, and pushes with [`git-push --mirror`](https://man.archlinux.org/man/git-push.1#:~:text=refs/heads/foo%20doesn%E2%80%99t%20exist.-,%2D%2Dmirror,-Instead%20of%20naming)