Pipelines

Up a Level

Pipelines, also known as actions, are automatic tasks that can run when you push up code to a specific branch[1] of a file. I mostly use them to automatically generate the EPUB and PDF files and then upload them to a well-known location. This lets me make a change, commit[2] it, push it up a remote repository[3], and then go to the repository and see the results within minutes.

1: ../branches/

2: ../commits/

3: ../repositories/

I also use it to generate the EPUB and PDF files so they can be published to my website or downloaded to my computer so I always have the latest version of every story or book I've written.

Pipeline Format

How a pipeline is described and what it can do is very specific to individual forges[4]. I'll give examples of how to use them specific in those details, but the overall pattern is that I setup targets in Just[5] such as `just build-epub` or `just publish` and then have the pipelines call that. Doing it this way means I can test it locally by running the command by hand, or I can trace through it.

4: ../forges/

5: ../just/

build: build-epub build-pdf

build-epub:
    mfgames-writing build epub

build-pdf:
    mfgames-writing build pdf

publish: build
    zip allegro.zip allegro-*
    scp allegro.zip fedran.com:~/allegro/ebooks.zip

My actual set up is a bit more complicated but I could generate the PDF by calling `just build-pdf` or I could also copy it all up to the server by running `just publish` which would then call `build` which would call `build-pdf`.

Footer

Below are various useful links within this site and to related sites (not all have been converted over to Gemini).