Skip to content

GitHub Action for setting up the MSFS SDK

License

Notifications You must be signed in to change notification settings

koesie10/setup-msfs-sdk

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

setup-msfs-sdk status

Setup MSFS SDK Action

This action can be used to setup the MSFS SDK from a ZIP file. It will set the MSFS_SDK environment variable to the path of the SDK.

Usage

steps:
- uses: koesie10/setup-msfs-sdk@v1
  with:
    url: ${{ secrets.MSFS_SDK_URL }}

Code in Main

First, you'll need to have a reasonably modern version of node handy. This won't work with versions older than 9, for instance.

Install the dependencies

$ npm install

Build the typescript and package it for distribution

$ npm run build && npm run package

Run the tests ✔️

$ npm test

 PASS  ./index.test.js
  ✓ throws invalid number (3ms)
  ✓ wait 500 ms (504ms)
  ✓ test runs (95ms)

...

Publish to a distribution branch

Actions are run from GitHub repos so we will checkin the packed dist folder.

Then run ncc and push the results:

npm run package
git add dist
git commit -a -m "prod dependencies"
git push origin releases/v1

Note: We recommend using the --license option for ncc, which will create a license file for all of the production node modules used in your project.

Your action is now published! 🚀

See the versioning documentation

Validate

You can now validate the action by referencing ./ in a workflow in your repo (see test.yml)

uses: ./
with:
  url: ${{ secrets.MSFS_SDK_URL }}

See the actions tab for runs of this action! 🚀

Usage:

After testing you can create a v1 tag to reference the stable and latest V1 action