Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/carlkidcrypto/os-specific-runner
os-specific-runner
https://github.com/carlkidcrypto/os-specific-runner
continuous-integration github-actions os-runner os-specific os-specific-run os-specific-runner utilities
Last synced: 9 days ago
JSON representation
os-specific-runner
- Host: GitHub
- URL: https://github.com/carlkidcrypto/os-specific-runner
- Owner: carlkidcrypto
- License: mit
- Created: 2023-12-15T15:20:01.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-24T15:58:22.000Z (about 1 month ago)
- Last Synced: 2024-11-24T16:38:40.812Z (about 1 month ago)
- Topics: continuous-integration, github-actions, os-runner, os-specific, os-specific-run, os-specific-runner, utilities
- Language: JavaScript
- Homepage:
- Size: 490 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# os-specific-runner
All credit for the original work goes to (KnicKnic). This is a detached-fork of .
This version (2.0.0 and beyond) will attempt to stay upto date on the lastest version of NPM and other dependecies.
## Status Badge(s)
| [](https://github.com/carlkidcrypto/os-specific-runner/actions/workflows/tests.yml) | [](https://github.com/carlkidcrypto/os-specific-runner/actions/workflows/github-code-scanning/codeql) | [](https://github.com/carlkidcrypto/os-specific-runner/actions/workflows/regenerate.yml) | [](https://github.com/carlkidcrypto/os-specific-runner/releases) | [](https://github.com/carlkidcrypto/os-specific-runner/releases/tag/v2.1.0) |
| --------------- | --------------- | --------------- | --------------- | --------------- |
## How to Support This Project
## About
A github action for running a separate command based on the os
```yaml
- uses: carlkidcrypto/[email protected]
with:
macos: echo "Hi from macos"
linux: |
echo "Hi from linux"
echo "Hi from linux second line"
windows: echo "Hi from windows"
```
## Keeping actions up-to-date
Enable dependabot to get notifications for updated actions by creating [.github/dependabot.yml](https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/configuration-options-for-dependency-updates#about-the-dependabotyml-file) in your repository with the [actions configurations](https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot#enabling-dependabot-version-updates-for-actions)
## Params
### (optional) Command you wish to run
| os | command value |
|---------|-----------------------------------------|
| macos | echo "No command specified for macos" |
| linux | echo "No command specified for linux" |
| windows | echo "No command specified for windows" |
### (optional) Shell you wish to use
| os | command value |
|---------|-----------------------------------------|
| macosShell | bash |
| linuxShell | bash |
| windowsShell | pwsh |
See for more details
## Full Example
```yaml
name: test
on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: ["ubuntu-latest", "windows-latest", "macos-latest"]
steps:
- uses: actions/checkout@v4
- uses: carlkidcrypto/[email protected]
with:
macos: echo "Hi from macos"
linux: |
echo "Hi from linux"
echo "Hi from linux second line"
windows: echo "Hi from windows"
```
## Alternatives
You can do what this project accomplishes with simple `if` statements in github actions.
The problem is you have to figure them out, and they end up creating multiple steps one per each OS. I think a single step (rather than multiple steps in each OS that are not run) looks cleaner and is more obvious what failed. More details on if statements -
## Developer instructions
### Setup Environment
```pwsh
npm install -g [email protected]
npm i -g @vercel/[email protected]
npm install
```
### Update lock file
```pwsh
npm update
```
### Update project
```pwsh
ncc build index.js -m
```
### Run tests