• The get-cmake action for downloading and caching CMake and ninja binaries on the GitHub agents.
  • Quickstart
  • Action reference: all input/output parameters
  • Who is using get-cmake
• Developers information
  • Prerequisites
  • Build and lint
  • Packaging
  • Testing
  • Contributing
• License

The get-cmake action for downloading and caching CMake and ninja binaries on the GitHub agents.

Restores from cache, or downloads and caches CMake v3.23.2 and Ninja v1.11.0. Works for x64 on Linux/macOS/Windows.

Flowchart of get-cmake:

1. If cache hit occurs, CMake and ninja are restored from cache in less than 1 second;
2. If cache miss occurs, the action downloads and installs CMake and ninja, then caches both automatically with GitHub's @actions/cache APIs;
3. Adds to PATH the CMake and ninja executables;

Quickstart

    # - uses: actions/cache@v1  <-----= YOU DO NOT NEED THIS
    #   key: <key>              <-----= YOU DO NOT NEED THIS
    #   path: <path>            <-----= YOU DO NOT NEED THIS

    - name: Get latest CMake and ninja
      # Using 'latest' branch, the most recent CMake and ninja are installed.
      uses: lukka/get-cmake@latest        ⟸ THIS IS THE ONE LINER YOU NEED
          
    # If you need to pin your workflow to specific CMake version you can use the 'tag' to select the version.
    - name: Get specific version CMake, v3.23.2
      uses: lukka/[email protected]   ⟸ THIS IS THE ONE LINER YOU NEED

Action reference: all input/output parameters

There are no inputs, nor outputs.

action.yml

Who is using get-cmake

This graph shows the list of public repositories with more than 25 stars using get-cmake.

Developers information

Prerequisites

gulp 4 globally installed.

Build and lint

Build with tsc running:

npm run build

Launch lint by:

npm run lint

Packaging

To build, lint validate and package the extension for release purpose, run:

npm run pack

Testing

To build, pack and test:

npm run test

To run test directly:

jest

Contributing

The software is provided as is, there is no warranty of any kind. All users are encouraged to improve the source code with fixes and new features.

License

All the content in this repository is licensed under the MIT License.

Copyright (c) 2020-2021-2022 Luca Cappa