artifact-submissions

This repository is where submissions to add or modify artifacts in Ace Archive are collected for manual review. Want to submit an artifact to the archive? Fill out this form on the website.

Submission pipeline

Each submission is a JSON file in the submissions/ directory which is generated by a form on Ace Archive. That form redirects users here to open an issue, passing JSON body as a query parameter. Then a team member can open a PR to add that submission to the repo.

When a PR is opened, acearchive/artifact-submit-action validates that the artifact submission JSON matches the expected schema. This action also downloads any files referenced in the submission to determine their media type and calculate their hash, and then a bot adds those fields to the JSON file and commits the changes to the branch.

This bot will not attempt to overwrite existing file hashes or media types, so team members can manually edit the JSON if necessary without the bot overwriting their changes. Likewise, team members can delete the file hash or media type fields to have the bot recalculate them.

When a PR is merged, the action downloads the files, re-hashes them to verify that the contents at the URL haven't changed since the PR was approved, and then uploads them to Ace Archive.

Additionally, acearchive/hugo-artifact-action is used to automatically generate static assets from the artifact submissions which are used to build the static site.

Metadata

This repo also contains site-wide metadata, in metadata.json. Currently, this just includes the descriptions associated with tags (collections, decades, identities, people, etc.). When a PR is merged, acearchive/artifact-submit-action uploads this metadata to Ace Archive.

Deployments

There are two deployments of Ace Archive, each with their own infrastructure stack: A dev environment and a prod environment.

Merging artifact submissions to the main branch will upload them to the prod environment, and pushing or merging submission to the dev branch will upload them to the dev environment.

Migrations

We may periodically need to change the format of these submission files. Each submission file contains a top-level version key which indicates the current version.