Skip to main content

Module private_assets

Module private_assets 

Source
Expand description

private-assets [--library | --pin]: fetches the files a game may not hand out (bought art, say) from a private repository, checked out into a git-ignored folder of the project (PrivateAssets::checkout) at the commit the project’s pin file names (PrivateAssets::pin_file).

With no flag the command clones the checkout if it isn’t there (only PrivateAssets::folders, and without the history’s files), fetches, and puts it at the pinned commit; then it copies PrivateAssets::copies out of it into the project (voice clips that ship as files beside the game, say). --library also brings PrivateAssets::library. --pin writes the commit the checkout is at into the pin file, after checking that it is pushed to the repository’s main and that every file in the credited folders has a credit (PrivateAssets::credits). A full clone made by hand is left whole.

Enums§

Mode
What the command was asked to do.

Functions§

parse_args
Parses the arguments after private-assets. The error is the usage line.
run
Runs the command in the project at root against the private repository at url (the rules’ own, but for tests). command is the tool’s name in what it says.
usage
The usage line, with command as the tool’s name.