The action-ccstudio-ide GitHub Action provides an automated environment for building projects within the Code Composer Studio from Texas Instruments Inc. This action facilitates continuous integration and delivery (CI/CD) for embedded projects, leveraging the robust features of Code Composer Studio, which is an integrated development environment (IDE) designed specifically for TI's microcontrollers and processors.

To use this action in your workflow, add the following steps to your .github/workflows YAML file:

name: Build Project with CCS IDE

on:
    push:
        branches: [ main ]
    pull_request:
        branches: [ main ]

jobs:
    build:
        runs-on: ubuntu-22.04
        steps:
        - uses: actions/[email protected]
        - name: Build with Code Composer Studio IDE
        uses: uoohyo/[email protected]
        with:
            project-path: 'Project/YourProjectName'
            project-name: 'YourProjectName'
            build-config: 'Debug'
            major-ver: '12'
            minor-ver: '7'
            patch-ver: '0'
            build-ver: '00007'
            components: 'PF_C28'

The project-path input specifies the relative path to the project within your repository that you want to build using the Code Composer Studio IDE. This path should lead directly to the project's root where the project files are located.

with:
    project-path: 'path/to/your/project'

The project-name input specifies the name of the project within your Code Composer Studio workspace that you want to build. This name should exactly match the project name in CCS.

with:
    project-name: 'ExampleProject'

The build-config input determines which build configuration to use when compiling the project. Typical configurations include Debug or Release, but any custom configuration defined in your CCS project can be used.

with:
    build-config: 'Release'  # Optional, defaults to 'Debug'

Default Value: If not specified, the build configuration defaults to Debug.

The structure of the Code Composer Studio version is as follows:

<major-ver> . <minor-ver> . <patch-ver> . <build-ver>

As of April 24, 2024, the latest released version of Code Composer Studio is 12.7.0.00007. The default environment variables are set accordingly

with:
    major-ver: '12'
    minor-ver: '7'
    patch-ver: '0'
    build-ver: '00007'

For the latest version information, visit this link.

When installing Code Composer Studio, you can choose from various Texas Instruments Inc. product families. Below is a list of installable product families:

Multiple product families can be installed by separating their names with a comma in the COMPONENTS variable. Here is an example that installs development tools for both PF_MSP430 and PF_CC2X:

with:
    components: 'PF_MSP430, PF_CC2X'

MIT License

Copyright (c) 2024 uoohyo

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.