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

Restores from cache, or downloads and caches Ninja. Works for x64 on Linux/macOS/Windows.

Flowchart of action-get-ninja:

1. If cache hit occurs, ninja is restored from cache in less than 1 second;
2. If cache miss occurs, the action downloads and installs ninja, then caches both automatically with GitHub's @actions/cache APIs;
3. Adds to PATH the 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 ninja
      # Using 'v1' branch, the most recent ninja is installed. (1.10.2)
      uses: urkle/action-get-ninja@v1        ⟸ THIS IS THE ONE LINER YOU NEED
          
    # If you need to pin your workflow to specific ninja you can specify the version.
    - name: Get specific version Ninja 0.9.0
      uses: urkle/action-get-ninja@v1
      with:
        version: 1.9.0 

Developer Manual

• Developers information
  • Prerequisites
  • Packaging
  • Testing
• Contributing
• License

Action reference: all input/output parameters

There are no inputs, nor outputs.

action.yml

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 Luca Cappa Copyright (c) 2021 Edward Rudd