install-cadius-action

A Github Action for installing Cadius and allowing you to manipulate ProDOS disk images in your workflows.

Building from source

npm install
npm run all

This compiles index.ts with TypeScript and bundles the output with ncc into dist/index.js.

Example usage

    # This will install Cadius on your Github Runner machine
    - name: Install Cadius
      uses: digarok/install-cadius-action@master
      with:
        include_prodos: true
    
    # Now you can use it to create a new bootable ProDOS disk
    - name: Create Boot Volume
    - run: |
        cadius createvolume exampledsk.po exampledsk 140KB
        cadius addfile exampledsk.po /exampledsk/ ./PRODOS.2.4.3/PRODOS

Arguments/Inputs

Input	Default	Description
version	(none)	Release tag of Cadius to install from the selected source.
source	digarok	Which Cadius distribution to install. Accepts digarok (this fork) or mach-kernel.
url	(none)	Optional direct URL to a Cadius .zip archive or raw binary. Overrides source/version when set.
include_prodos	true	Also download and extract ProDOS 2.4.3 so you can assemble a bootable disk.

include_prodos defaults to true and will download the latest release of ProDOS (2.4.3) and extract all of the files to a directory called PRODOS.2.4.3. This allows you to use those files, if needed, in subsequent steps — so you can create a bootable disk or even add BASIC.SYSTEM to launch into AppleSoft BASIC. If you don't need any of the ProDOS files, you can skip this by setting it to false and save a second or two.

Choosing an alternate Cadius build

    - name: Install Cadius (mach-kernel fork)
      uses: digarok/install-cadius-action@master
      with:
        source: mach-kernel
        version: v1.1.0

Installing from a custom URL

    - name: Install Cadius from a custom release
      uses: digarok/install-cadius-action@master
      with:
        url: https://example.com/builds/cadius-linux-custom.zip

The url input accepts either a .zip archive (it will be extracted) or a raw binary (it will be staged as cadius / cadius.exe).

Usage Recommendations

1. While you can call Cadius directly from run commands as shown above, it makes sense to put your packaging command(s) in a script which can be run locally with the same results.
2. Cadius uses a specific file, _FileInformation.txt for inferring ProDOS filetype and access information. That is not covered here, see the Cadius Documentation.
3. This action is intended to pair really well with my install-merlin32-action which let's you assembled the 65xx source code to build your object/system files that can then packaged inside a ProDOS image file using this action for immediate use in your emulator or flash drive. I use this workflow to handle build and release all via Github Actions.

About CADIUS

Cadius is a disk image program originally by the amazing French team, Brutal Deluxe. They are not involved with this Open Source version, but I do recommend you view their site for more information on Cadius and their other incredible tools and releases.

Further Examples

For a fully-integrated pipeline, see my example Apple II project here (https://github.com/digarok/apple2-assembly-github-actions-ci-example).