Skip to content

A GitHub Action used to turn dynamic content into static pages for the Ace Archive site

License

Notifications You must be signed in to change notification settings

acearchive/hugo-artifact-action

Repository files navigation

hugo-artifact-action

This is a GitHub action used to build the Ace Archive site using Hugo.

We use Hugo, a static site generator, to build the Ace Archive site. The way Hugo works means that each published page on the site needs to have a corresponding markdown file in the source. Hugo uses a text templating language to allow you to populate the page using structured data in a YAML frontmatter block.

This action generates a markdown file in a specified directory in the checked-out repository for each artifact in Ace Archive. It also adds a YAML frontmatter block to each of those markdown files containing the artifact metadata.

This action is used by acearchive/artifact-submissions to generate these markdown files in acearchive/hugo-artifacts. The latter repository is then imported by acearchive/acearchive.lgbt as a Hugo module at build time.

Obviously this is a somewhat convoluted system and is pushing the boundaries of what can sanely be done with a static site generator. Still, it allows us to serve these pages as static assets. In the future, artifact pages on the site may be served by an edge function instead.

See the action.yaml for documentation of the input parameters.

About

A GitHub Action used to turn dynamic content into static pages for the Ace Archive site

Topics

Resources

License

Stars

Watchers

Forks