Build index via Github Actions

[tenmozes]

Is there any recommendation on how to build an index via GitHub actions?

the case - public documentation on GitHub anyone may change, after changes there is deployment on site, and I want to update the index

[bglw]

Hey @tenmozes 👋

I don't know that I have any specific recommendations — generally just running Pagefind in between your build step and your deployment step is all that is needed.

Browsing examples of usage is usually your best bet, to see what others are doing — here's a pretty good GitHub code search for finding existing Pagefind actions:

https://github.com/search?q=pagefind+path%3A.github%2Fworkflows%2F*+-org%3Acloudcannon+&type=code

Let me know if that helps at all, or I'm happy to help dig into to anything more specific 🙂

[tenmozes]

@bglw thank you for the link, it covers my question

the main reason why i asked that, i guess the node dependency and npx is a bit overkill for indexing as far pagefind is a compilable binary
if there is no lightweight solution, i will definitely add node as dependency in github action

thank you again

[bglw]

Oh I get ya — supplypike/setup-bin is a lovely action for this. I use this for a crate packaged the same way as Pagefind. e.g. in one of Pagefind's actions:

pagefind/.github/workflows/test.yml

Lines 78 to 83 in ca82a78

	- name: Install humane
	uses: supplypike/setup-bin@v3
	with:
	uri: "https://github.com/CloudCannon/humane/releases/download/v${{env.HUMANE_VERSION}}/humane-v${{env.HUMANE_VERSION}}-${{matrix.target}}.tar.gz"
	name: "humane"
	version: ${{env.HUMANE_VERSION}}

If you put a Pagefind release tar.gz link in there and change the name and version, that action handles downloading, extracting, and putting the binary on the PATH.

[tenmozes]

perfect, thank you!