Add development info to readme #31
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: "CI" | |
| env: | |
| RATOS_CONFIGURATION_PATH: ${{ github.workspace }}/ratos-configuration | |
| KLIPPER_CONFIG_PATH: ${{ github.workspace }}/config | |
| RATOS_SCRIPT_DIR: ${{ github.workspace }}/ratos-configurator/src/scripts | |
| KLIPPER_DIR: ${{ github.workspace }}/klipper | |
| KLIPPER_ENV: ${{ github.workspace }}/klippy-env | |
| MOONRAKER_DIR: ${{ github.workspace }}/moonraker | |
| LOG_FILE: ${{ github.workspace }}/ratos-configurator.log | |
| RATOS_DATA_DIR: ${{ github.workspace }}/ratos-data | |
| on: | |
| push: | |
| branches: | |
| - "development" | |
| pull_request: | |
| branches: | |
| - "**" | |
| workflow_dispatch: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.head_ref || github.ref_name }} | |
| cancel-in-progress: true | |
| jobs: | |
| checkout_dependencies: | |
| name: Lint, Typecheck and Tests | |
| runs-on: ubuntu-latest | |
| outputs: | |
| STORE_PATH: ${{ steps.generate-keys.outputs.STORE_PATH }} | |
| CACHE_KEY: ${{ steps.generate-keys.outputs.STORE_PATH }} | |
| bin_dest: ${{ steps.pnpm-install.outputs.bin_dest }} | |
| dest: ${{ steps.pnpm-install.outputs.dest }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: Rat-OS/RatOS-configurator | |
| path: "ratos-configurator" | |
| - name: Install Node | |
| uses: actions/[email protected] | |
| with: | |
| # Version Spec of the version to use. Examples: 12.x, 10.15.1, >=10.15.0. | |
| node-version: 18.x | |
| - uses: pnpm/action-setup@v2 | |
| name: Install pnpm | |
| id: pnpm-install | |
| with: | |
| version: 8 | |
| run_install: false | |
| - name: Generate keys | |
| id: generate-keys | |
| shell: bash | |
| env: | |
| cache_key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml', '**/.git/refs/heads/*') }} | |
| run: | | |
| echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT | |
| echo "CACHE_KEY=$cache_key" >> $GITHUB_OUTPUT | |
| - uses: actions/cache@v3 | |
| name: pnpm cache | |
| id: cache | |
| with: | |
| path: | | |
| ${{ steps.generate-keys.outputs.STORE_PATH }} | |
| key: ${{ steps.generate-keys.outputs.CACHE_KEY }} | |
| - name: Dependencies | |
| working-directory: ratos-configurator/src | |
| run: pnpm install --frozen-lockfile | |
| - name: Checkout RatOS Configuration | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: Rat-OS/RatOS-configuration | |
| path: "ratos-configuration" | |
| ref: ${{ github.ref_name }} | |
| - name: Checkout Klipper | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: klipper3d/klipper | |
| path: "klipper" | |
| - name: Checkout Moonraker | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: Arksine/moonraker | |
| path: "moonraker" | |
| - name: Lint | |
| working-directory: ratos-configurator/src | |
| run: pnpm run lint:ci | |
| - name: Typecheck | |
| uses: fersilva16/[email protected] | |
| if: success() || failure() # run this step even if previous step failed | |
| with: | |
| project: ratos-configurator/src/tsconfig.json | |
| - name: Run test suite | |
| working-directory: ratos-configurator/src | |
| if: success() || failure() # run this step even if previous step failed | |
| run: pnpm run test:ci --outputFile=./report.xml | |
| - name: Upload reports | |
| uses: actions/upload-artifact@v3 # upload test results | |
| if: success() || failure() # run this step even if previous step failed | |
| with: | |
| name: test-results | |
| path: | | |
| ratos-configurator/src/report.xml | |
| ratos-configurator/src/eslint_report.json | |
| - name: Report status | |
| if: ${{ failure() }} | |
| run: exit 1 |