Apple-2-Tools/install-cadius-action
1
0
Fork 0
mirror of https://github.com/digarok/install-cadius-action.git synced 2024-12-26 00:31:36 +00:00
Code Issues Projects Releases Wiki Activity
Install Cadius with this simple Github Action -- enable ProDOS images in your workflows!
13 Commits 2 Branches 4 Tags 102 KiB
TypeScript 100%
b6686f5762
Go to file
Dagen Brock b6686f5762 rebuild
2021-03-23 16:34:45 -05:00
.github cicd 2021-03-23 16:29:31 -05:00
dist rebuild 2021-03-23 16:34:45 -05:00
src fix documentation and branding for release 2020-03-06 11:41:40 -06:00
.gitignore fix documentation and branding for release 2020-03-06 11:41:40 -06:00
action.yml fix documentation and branding for release 2020-03-06 11:41:40 -06:00
LICENSE initial test version 2020-03-06 11:41:25 -06:00
package-lock.json rebuild 2021-03-23 16:34:45 -05:00
package.json rebuild 2021-03-23 16:34:45 -05:00
README.md update package 2021-03-23 16:27:58 -05:00
tsconfig.json Latest with inputs, P8 download and extractions 2020-03-06 11:41:40 -06:00

README.md

latest workflow

install-cadius-action

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

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.2/PRODOS

Arguments/Inputs

This action has one input: include_prodos. It defaults to true, it will download the latest release of ProDOS (2.4.2) and extract all of the files to a directory called PRODOS.2.4.2. 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.

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).