Update documentation based on feedback #229
Workflow file for this run
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
| --- | |
| # This workflow is used for Continuous Integration for the backstage/ directory. | |
| name: CI for backstage/ | |
| on: | |
| pull_request: | |
| branches: | |
| - main | |
| paths: | |
| - "backstage/**" | |
| jobs: | |
| test-linux: | |
| strategy: | |
| matrix: | |
| node-version: [18.x] | |
| name: Node.js v${{ matrix.node-version }} on Linux | |
| runs-on: ubuntu-latest | |
| defaults: | |
| run: | |
| working-directory: ./backstage | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Use Node.js ${{ matrix.node-version }} | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| cache: "yarn" | |
| cache-dependency-path: "backstage/yarn.lock" | |
| - name: Use Yarn v1 | |
| run: | | |
| corepack enable | |
| corepack prepare [email protected] --activate | |
| # Prevent churn | |
| if ! grep -q 'yarn lockfile v1' yarn.lock; then | |
| echo "::error file=yarn.lock,line=1,endLine=1,title=Error: Unexpected changes to yarn.lock::We expect the yarn lockfile use v1. To use newer versions of Yarn follow the migration guide at https://backstage.io/docs/tutorials/yarn-migration." | |
| fi | |
| - name: Install Task | |
| uses: arduino/setup-task@v2 | |
| - name: Install dependencies | |
| run: yarn install --immutable | |
| - name: Build | |
| run: | | |
| # Fetch origin/main used by the "lint" npm script | |
| git fetch origin main | |
| # Create the credentials file that is used by the "build" npm script | |
| touch github-app-integration-credentials.yaml | |
| task backstage:build | |
| - name: Test | |
| run: yarn test | |
| test-windows: | |
| strategy: | |
| matrix: | |
| node-version: [18.x] | |
| name: Node.js v${{ matrix.node-version }} on Windows | |
| runs-on: windows-latest | |
| defaults: | |
| run: | |
| working-directory: ./backstage | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Use Node.js ${{ matrix.node-version }} | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| cache: "yarn" | |
| cache-dependency-path: "backstage/yarn.lock" | |
| - name: Use Yarn v1 | |
| if: ${{ false }} # Skip on Windows | |
| run: | | |
| corepack enable | |
| corepack prepare [email protected] --activate | |
| # Prevent churn | |
| if ! grep -q 'yarn lockfile v1' yarn.lock; then | |
| echo "::error file=yarn.lock,line=1,endLine=1,title=Error: Unexpected changes to yarn.lock::We expect the yarn lockfile use v1. To use newer versions of Yarn follow the migration guide at https://backstage.io/docs/tutorials/yarn-migration." | |
| fi | |
| - name: Install Task | |
| uses: arduino/setup-task@v2 | |
| - name: Install dependencies | |
| run: | | |
| yarn config set network-timeout 300000 | |
| yarn install --immutable | |
| - name: Build | |
| run: | | |
| # Fetch origin/main used by the "lint" npm script | |
| git fetch origin main | |
| # Create the credentials file that is used by the "build" npm script | |
| echo $null >github-app-integration-credentials.yaml | |
| task backstage:build | |
| - name: Test | |
| run: yarn test |