Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lukka/get-cmake

Install and Cache latest CMake and Ninja for your workflows on your GitHub
https://github.com/lukka/get-cmake

build cmake continuous-integration cplusplus cpp github-action ninja vcpkg

Last synced: 11 days ago
JSON representation

Install and Cache latest CMake and Ninja for your workflows on your GitHub

Host: GitHub
URL: https://github.com/lukka/get-cmake
Owner: lukka
License: mit
Created: 2020-04-03T07:38:04.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2024-10-25T17:10:13.000Z (18 days ago)
Last Synced: 2024-10-29T10:41:43.469Z (14 days ago)
Topics: build, cmake, continuous-integration, cplusplus, cpp, github-action, ninja, vcpkg
Language: TypeScript
Homepage:
Size: 3.73 MB
Stars: 103
Watchers: 4
Forks: 16
Open Issues: 1
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt

Awesome Lists containing this project

README

        [![Action Status](https://github.com/lukka/get-cmake/workflows/build-test/badge.svg)](https://github.com/lukka/get-cmake/actions)

[![Coverage Status](https://coveralls.io/repos/github/lukka/get-cmake/badge.svg?branch=main)](https://coveralls.io/github/lukka/get-cmake?branch=main)

- [The **get-cmake** action installs as fast as possible your desired versions of CMake and Ninja](#the-get-cmake-action-installs-as-fast-as-possible-your-desired-versions-of-cmake-and-ninja)

  - [Quickstart](#quickstart)

    - [If you want to use  **latest stable** you can use this one-liner:](#if-you-want-to-use--latest-stable-you-can-use-this-one-liner)

    - [If you want to **pin** the workflow to **specific range of versions** of CMake and Ninja:](#if-you-want-to-pin-the-workflow-to-specific-range-of-versions-of-cmake-and-ninja)

  - [Action reference: all input/output parameters](#action-reference-all-inputoutput-parameters)

  - [Who is using `get-cmake`](#who-is-using-get-cmake)

- [Developers information](#developers-information)

  - [Prerequisites](#prerequisites)

  - [Build and lint](#build-and-lint)

  - [Generate the catalog of CMake releases](#generate-the-catalog-of-cmake-releases)

  - [Packaging](#packaging)

  - [Testing](#testing)

  - [Contributing](#contributing)

- [License](#license)




# [The **get-cmake** action installs as fast as possible your desired versions of CMake and Ninja](https://github.com/marketplace/actions/get-cmake)

The action restores from local or cloud based cache both CMake and Ninja. If a `cache-miss` occurs, it downloads and caches the tools right away.

Works for `x64` and `arm64` hosts on Linux, macOS and Windows.

The desired version can be specified using [semantic versioning ranges](https://docs.npmjs.com/about-semantic-versioning), and also use `install` or `installrc` special tokens to install resp. the [latest stable](./.latest_cmake_version) or [release candidate](./.latestrc_cmake_version).

There are two kind of caches:

- The cloud based [GitHub cache](https://www.npmjs.com/package/@actions/cache). Enabled by default, it can be disabled using the input `useCloudCache:false`. 

- The local self-hosted runner cache, stored locally using [tool-cache](https://www.npmjs.com/package/@actions/tool-cache). Disabled by default, it can enabled with the input `useLocalCache:true`. 

Steps of `get-cmake`:

  1. If a `cache-hit` occurs (either local or cloud cache), CMake and Ninja are restored from the cache.

     1. if both local and cloud are enabled, the local cache check goes first.

  2. If a `cache-miss` occurs, i.e. none of the enabled caches hit:

     1. the action downloads and installs the desired versions of CMake and Ninja.

     2. the action stores CMake and Ninja for the enabled caches:

        1. if enabled, on the [cloud based GitHub cache](https://www.npmjs.com/package/@actions/cache). This is beneficial for the next run of the workflow especially on _GitHub-hosted runners_.

        2. if enabled, on the local GitHub runner cache. This is beneficial for the next run of the workflow on the same _self-hosted runner_.

        

        _Note:_ when there is a `cache-hit`, nothing will be stored in any of the caches.

  3. Adds to the `PATH` environment variable the binary directories for CMake and Ninja.

  




## Quickstart

### If you want to use  **latest stable** you can use this one-liner:

```yaml

  # Option 1: using 'latest' branch, the most recent CMake and ninja are installed.

    - uses: lukka/get-cmake@latest  # <--= Just this one-liner suffices.

```

The local and cloud cache can be enabled or disabled, for example:

```yaml

    # Suited for self-hosted GH runners where the local cache wins over the cloud.

    - uses: lukka/get-cmake@latest  

      with:

        useLocalCache: true         # <--= Use the local cache (default is 'false').

        useCloudCache: false        # <--= Ditch the cloud cache (default is 'true').

```

And there is a second option:

```yaml

  # Option 2: specify 'latest' or 'latestrc' in the input version arguments:

    - name: Get latest CMake and Ninja

      uses: lukka/get-cmake@latest

      with:

        cmakeVersion: latestrc      # <--= optional, use the latest release candidate (notice the 'rc' suffix).

        ninjaVersion: latest        # <--= optional, use the latest release (non candidate).

```




### If you want to **pin** the workflow to **specific range of versions** of CMake and Ninja:

```yaml

  # Option 1: specify in a input parameter the desired version using ranges.

  - uses: lukka/get-cmake@latest

    with:

      cmakeVersion: "~3.25.0"  # <--= optional, use most recent 3.25.x version

      ninjaVersion: "^1.11.1"  # <--= optional, use most recent 1.x version

  # or using a specific version (no range)

  - uses: lukka/get-cmake@latest

    with:

      cmakeVersion: 3.25.2     # <--= optional, stick to exactly 3.25.2 version

      ninjaVersion: 1.11.1     # <--= optional, stick to exactly 1.11.1 version

```

or there is another option:

```yaml

  # Option 2: or you can use the Git 'tag' to select the version, and you can have a one-liner statement,

  # but note that you can only use one of the existing tags, create a PR to add the tag you need!

  - name: Get specific version CMake, v3.26.0

    uses: lukka/[email protected]     # <- this one-liner is all you need.

```




## Action reference: all input/output parameters

Please read [action.yml](./action.yml).




## Who is using `get-cmake`

[This graph](https://lukka.github.io/graph/graph.html) shows the list of public repositories with more than 25 stars using `get-cmake`.




# Developers information

## Prerequisites

[gulp 4](https://www.npmjs.com/package/gulp4) globally installed.




## Build and lint

Build with `tsc` running:

 > npm run build

Launch `lint` by:

 > npm run lint




## Generate the catalog of CMake releases

To generate the catalog of CMake releases, run a special test with this command:

 > npm run generate-catalog

Then embed the new catalog by packaging the action.




## Packaging

To build, lint validate and package the extension (and embed the release catalog) for release purpose, run:

  > npm run pack




## Testing

To build, pack and run all tests:

 

 > npm run test

 To run all tests:

 

 > npx jest

 or

 > npx jest -- -t "<regex to match the describe clause>"




## Contributing

The software is provided as is, there is no warranty of any kind. All users are encouraged to improve the [source code](https://github.com/lukka/get-cmake) with fixes and new features.




# License

All the content in this repository is licensed under the [MIT License](LICENSE.txt).

Copyright (c) 2020-2021-2022-2023-2024 Luca Cappa