Using CodeTidy in my GitHub automated workflow for linting ObjsectScript code

To set up an automated linting and code style validation for InterSystems ObjectScript code using CodeTidy and GitHub Actions:

1. Install the CodeTidy Package:

   • Ensure that you have ObjectScript Package Manager (ZPM) installed.
   • Use the command:

     zpm "install isc.codetidy"
     

     This will install the CodeTidy package required for linting ObjectScript code [1].

2. Configure GitHub Actions Workflow:

   • Create a GitHub Actions workflow file in your repository. For example, create a file .github/workflows/objectscript-linting.yml.
   • Define your GitHub Action to include steps where CodeTidy is executed during your CI pipeline.
   • Example workflow:

     name: ObjectScript Lint
     
     on:
       push:
         branches:
           - main
       pull_request:
     
     jobs:
       lint:
         runs-on: ubuntu-latest
         steps:
         - name: Checkout code
           uses: actions/checkout@v3
     
         - name: Install dependencies (ZPM if needed)
           run: |
             # Install ObjectScript Package Manager (if not pre-installed)
             zpm "install isc.codetidy"
     
         - name: Run CodeTidy for linting
           run: |
             # Add commands here to invoke CodeTidy linting
             # as per its documentation
     

     Customize this template based on your CodeTidy usage and specific requirements. Integrate any file exclusions or specific rules for your linting process [1][2].

Refer to the CodeTidy Documentation for specific commands and configurations related to linting operations [1].

Sources:

I think it's worth pinging CodeTidy's author @Timothy Leavitt 

On a side note, have you tried ObjectScript Quality for the same linting purpose? It is very naturally connected to GitHub Actions - you can add this file to any open-source GitHub repository with objectscript to see it in action, with examples.