Maintenance Scripts

This directory contains scripts that are used to maintain this package.

Beware! The contents of this directory are not source stable. They are provided as is, with no compatibility promises across package releases. Future versions of this package can arbitrarily change these files or remove them, without any advance notice. (This can include patch releases.)

• generate-docs.sh: A shell scripts that automates the generation of API documentation.

• generate-sources.sh: A shell script that invokes gyb to regenerate the contents of autogenerated/ directories. This needs to be run whenever a file with a .swift.gyb extension is updated.

• gyb, gyb.py: Generate Your Boilerplate. A rudimentary source code generation utility.

• gyb_utils.py: A Python module containing code generation utility definitions that are shared across multiple .swift.gyb files in this repository.

• run-full-tests.sh: A shell script that exercises many common configurations of this package in a semi-automated way. This is used before tagging a release to avoid accidentally shipping a package version that breaks some setups.

• shuffle-sources.sh: A legacy utility that randomly reorders Swift source files in a given directory. This is used to avoid reoccurrances of issue #7. (This is hopefully only relevant with compilers that the package no longer supports.)