comment: <> (Header Generated by ActionBuilderTool 1.1.0 (42))

ActionBuilderCore

Swift code that can take a Swift package, and create a Github Action workflow for it.

The workflow will build and test the package using Github Actions.

Configuration

The exact steps that the workflow executes can be configured.

These include:

• platforms to test, from: macOS, iOS, tvOS, watchOS, linux
• swift versions to test against, from: 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, and the nightly build
• the configuration to test: debug, release
• whether to run tests or just build
• whether to upload build logs
• whether to post a notification to a slack channel
• whether to ammend a header to the README
• whether to test against every requested swift version, or just the earliest and latest

These settings are read from an .actionbuilder.json file in the root of the package directory. If it is missing, some defaults are chosen.

If they aren’t explicitly set in the configuration file, the code attempts to pick sensible values by examining the Package.swift manifest:

• the tool version of the manifest is used to determine the version of Swift to test against.
• the platform minimum deployment versions listed in the manifest are used to determine platforms to test against

If the package manifest includes a minimum deployment for macOS, the linux platform is also added by default. If no minimum deployment information is present, the macOS and linux platforms are added by default. If these defaults aren’t what you need, you can specify exact values using a config file (see below).

Config Format

Here is an example of .actionbuilder.json:

{
    "name": "TestPackage",
    "owner": "TestOwner",
    "platforms": ["macOS", "linux"],
    "compilers": ["swift55", "swiftNightly"],
    "configurations": ["release"],
    "test": true,
    "header": false,
    "firstlast": false,
    "uploadLogs": false,
    "postSlackNotification": false
}

History

This code was originally part of Action Status, which is a little macOS/iOS tool I made for monitoring Github Actions.

I’ve now split the code out so that it can be used in other places.

I plan to remove the generation functionality from Action Status, and instead make a standlone Action Builder application (probably macOS only).

I have also created an SPM command plugin, so that you can generate workflows directly from the command line.