Updating Article Renderer to be able to return the focusedElement so that we can scroll these elements into view above the keypad. #2962
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
| name: Node CI | |
| on: | |
| pull_request: | |
| # edited is needed because that's the trigger when the base branch is | |
| # changed on a PR | |
| # The rest are the defaults. | |
| types: [edited, opened, synchronize, reopened] | |
| jobs: | |
| changeset: | |
| name: Check for .changeset entries for all changed files | |
| if: github.actor != 'dependabot[bot]' && github.actor != 'dependabot-preview[bot]' | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest] | |
| node-version: [16.x] | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Get changed files | |
| uses: Khan/actions@get-changed-files-v1 | |
| id: changed | |
| - name: Filter out files that don't need a changeset | |
| uses: Khan/actions@filter-files-v0 | |
| id: match | |
| with: | |
| changed-files: ${{ steps.changed.outputs.files }} | |
| files: "packages/, config/build/" # Only look for changes in packages, build | |
| globs: "!(**/__tests__/*), !(**/__testdata__/*), !(**/__stories__/*), !(**/dist/*)" # Ignore test files | |
| matchAllGlobs: true # Default is to match any of the globs, which ends up matching all files | |
| conjunctive: true # Only match files that match all of the above | |
| - name: Verify changeset entries | |
| uses: Khan/[email protected] | |
| with: | |
| changed_files: ${{ steps.match.outputs.filtered }} | |
| lint: | |
| name: Lint, Typecheck, Format, and Test | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest] | |
| node-version: [16.x] | |
| steps: | |
| - name: Checking out latest commit | |
| uses: actions/checkout@v2 | |
| - name: Use Node.js ${{ matrix.node-version }} & Install & cache node_modules | |
| uses: Khan/actions@shared-node-cache-v0 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| - name: Get All Changed Files | |
| uses: Khan/actions@get-changed-files-v1 | |
| id: changed | |
| - name: Check formatting | |
| run: | | |
| yarn -s prettier --check . | |
| - id: js-files | |
| name: Find .js(x)/.ts(x) changed files | |
| uses: Khan/actions@filter-files-v0 | |
| with: | |
| changed-files: ${{ steps.changed.outputs.files }} | |
| extensions: ".js,.jsx,.ts,.tsx" | |
| files: "yarn.lock" | |
| - id: eslint-reset | |
| uses: Khan/actions@filter-files-v0 | |
| name: Files that would trigger a full eslint run | |
| with: | |
| changed-files: ${{ steps.changed.outputs.files }} | |
| files: ".eslintrc.js,package.json,yarn.lock,.eslintignore" | |
| # Linting / type checking | |
| - name: Eslint | |
| uses: Khan/actions@full-or-limited-v0 | |
| with: | |
| full-trigger: ${{ steps.eslint-reset.outputs.filtered }} | |
| full: yarn lint packages | |
| limited-trigger: ${{ steps.js-files.outputs.filtered }} | |
| limited: yarn lint {} | |
| - name: Typecheck | |
| if: (success() || failure()) && steps.js-files.outputs.filtered != '[]' | |
| run: yarn typecheck | |
| - name: Build types | |
| if: (success() || failure()) && steps.js-files.outputs.filtered != '[]' | |
| run: yarn build:types | |
| # Run tests for our target matrix | |
| - id: jest-reset | |
| uses: Khan/actions@filter-files-v0 | |
| name: Files that would trigger a full jest run | |
| with: | |
| changed-files: ${{ steps.changed.outputs.files }} | |
| files: "jest.config.js,package.json,yarn.lock,test.config.js,test.transform.js" | |
| - name: Jest | |
| uses: Khan/actions@full-or-limited-v0 | |
| with: | |
| full-trigger: ${{ steps.jest-reset.outputs.filtered }} | |
| full: yarn jest | |
| limited-trigger: ${{ steps.js-files.outputs.filtered }} | |
| limited: yarn jest --passWithNoTests --findRelatedTests {} | |
| # We use STOPSHIP internally to mark code that's not safe to go live yet. | |
| # We use an if block because we want to return the exact inverse of what | |
| # `git grep` returns (0 on none found, 1 on some found). | |
| - name: Checks that STOPSHIP is not used in any files. | |
| run: ./utils/stopship-check.sh | |
| cypress: | |
| name: Cypress | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest] | |
| node-version: [16.x] | |
| steps: | |
| - name: Checking out latest commit | |
| uses: actions/checkout@v2 | |
| - name: Use Node.js ${{ matrix.node-version }} & Install & cache node_modules | |
| uses: Khan/actions@shared-node-cache-v0 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| - name: Run test with coverage | |
| run: yarn cypress:ci | |
| # Upload coverage report as an GitHub artifact so that it can be used | |
| # later in upload_coverage. | |
| - name: Upload Artifact | |
| uses: actions/upload-artifact@v2 | |
| with: | |
| name: cypress-coverage | |
| path: ./.nyc_output/out.json | |
| coverage: | |
| name: Jest Coverage | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest] | |
| node-version: [16.x] | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Use Node.js ${{ matrix.node-version }} & Install & cache node_modules | |
| uses: Khan/actions@shared-node-cache-v0 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| - name: Jest with coverage | |
| run: yarn coverage | |
| # Upload coverage report as an GitHub artifact so that it can be used | |
| # later in upload_coverage. | |
| - name: Upload Artifact | |
| uses: actions/upload-artifact@v2 | |
| with: | |
| name: jest-coverage | |
| path: ./coverage/coverage-final.json | |
| upload_coverage: | |
| name: Upload Coverage | |
| runs-on: ubuntu-latest | |
| needs: [cypress, coverage] | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Use Node.js ${{ matrix.node-version }} & Install & cache node_modules | |
| uses: Khan/actions@shared-node-cache-v0 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| - name: Download Jest Coverage | |
| uses: actions/download-artifact@v2 | |
| with: | |
| name: jest-coverage | |
| # path to decompress the artifact into, decompressed file | |
| # will be ./coverage-final.json | |
| path: ./ | |
| - name: Download Cypress Coverage | |
| uses: actions/download-artifact@v2 | |
| with: | |
| name: cypress-coverage | |
| # path to decompress the artifact into, decompressed file | |
| # will be ./out.json | |
| path: ./ | |
| # Upload both coverage files at once. This avoids issues where it Codecov | |
| # shows the results from only one of the reports which would make it appear | |
| # as though coverage dropped a lot. | |
| - name: Upload Coverage | |
| uses: codecov/codecov-action@v3 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| files: ./coverage-final.json,./out.json | |
| check_builds: | |
| name: Check builds for changes in size | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest] | |
| node-version: [16.x] | |
| steps: | |
| - name: Checking out latest commit | |
| uses: actions/checkout@v2 | |
| - name: Use Node.js ${{ matrix.node-version }} & Install & cache node_modules | |
| uses: Khan/actions@shared-node-cache-v0 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| # Make sure our packages aren't growing unexpectedly | |
| # This must come last as it builds the old code last and so leaves the | |
| # wrong code in place for the next job. | |
| - name: Check Builds | |
| uses: preactjs/compressed-size-action@v2 | |
| with: | |
| # We only care about the ES module size, really: | |
| pattern: "**/dist/es/index.js" | |
| # Always ignore SourceMaps and node_modules: | |
| exclude: "{**/*.map,**/node_modules/**}" | |
| # Clean up before a build | |
| clean-script: "clean" | |
| # Build production | |
| build-script: "build:prodsizecheck" | |
| extract_strings: | |
| name: Extract i18n strings | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest] | |
| node-version: [16.x] | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Use Node.js ${{ matrix.node-version }} & Install & cache node_modules | |
| uses: Khan/actions@shared-node-cache-v0 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| - name: Extract strings | |
| run: yarn extract-strings | |
| publish_snapshot: | |
| name: Publish npm snapshot | |
| # We don't publish snapshots on draft PRs or | |
| # on the main Changeset "Version Packages" PR | |
| if: | | |
| github.event.pull_request.draft == false | |
| && !startsWith(github.head_ref, 'changeset-release/') | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest] | |
| node-version: [16.x] | |
| steps: | |
| # We need to checkout all history, so that the changeseat tool can diff it | |
| - name: Checkout current commit | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: "0" | |
| - name: Ensure main branch is avaialble | |
| run: | | |
| REF=$(git rev-parse HEAD) | |
| git checkout main | |
| git checkout $REF | |
| - name: Use Node.js ${{ matrix.node-version }} & Install & cache node_modules | |
| uses: Khan/actions@shared-node-cache-v0 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| - name: Publish Snapshot Release to npm | |
| id: publish-snapshot | |
| run: ./utils/publish-snapshot.sh # All config is via Github env vars | |
| env: | |
| NPM_TOKEN: ${{ secrets.NPM_TOKEN }} | |
| - name: Calculate short SHA for this commit | |
| id: short-sha | |
| # Why not GITHUB_SHA here? Because that is the last merge-commit | |
| # for the PR (ie. the ephemeral commit that Github creates for | |
| # each PR merging the base branch into the pull request HEAD) for | |
| # Github Action runs). We want to reference the commit that was | |
| # pushed, not this ephemeral commit. | |
| run: echo "short_sha=$(echo ${{ github.event.pull_request.head.sha }} | cut -c1-8)" >> $GITHUB_OUTPUT | |
| # Note: these two actions are locked to the latest version that were | |
| # published when I created this yml file (just for security). | |
| - name: Find existing comment | |
| uses: peter-evans/find-comment@034abe94d3191f9c89d870519735beae326f2bdb | |
| id: find-comment | |
| with: | |
| issue-number: ${{ github.event.pull_request.number }} | |
| comment-author: "github-actions[bot]" | |
| body-includes: "npm Snapshot:" | |
| - name: Create or update npm snapshot comment - success | |
| if: steps.publish-snapshot.outputs.npm_snapshot_tag != '' | |
| uses: peter-evans/create-or-update-comment@67dcc547d311b736a8e6c5c236542148a47adc3d | |
| with: | |
| issue-number: ${{ github.event.pull_request.number }} | |
| comment-id: ${{ steps.find-comment.outputs.comment-id }} | |
| edit-mode: replace | |
| body: | | |
| # npm Snapshot: Published | |
| 🎉 Good news!! We've packaged up the latest commit from this PR (${{ | |
| steps.short-sha.outputs.short_sha }}) and published it to npm. You | |
| can install it using the tag `${{ | |
| steps.publish-snapshot.outputs.npm_snapshot_tag }}`. | |
| Example: | |
| ```sh | |
| yarn add @khanacademy/perseus@${{ | |
| steps.publish-snapshot.outputs.npm_snapshot_tag }} | |
| ``` | |
| - name: Create or update npm snapshot comment - failure | |
| if: steps.publish-snapshot.outputs.npm_snapshot_tag == '' | |
| uses: peter-evans/create-or-update-comment@67dcc547d311b736a8e6c5c236542148a47adc3d | |
| with: | |
| issue-number: ${{ github.event.pull_request.number }} | |
| comment-id: ${{ steps.find-comment.outputs.comment-id }} | |
| edit-mode: replace | |
| body: | | |
| # npm Snapshot: **NOT** Published | |
| 🤕 Oh noes!! We couldn't find any changesets in this PR (${{ | |
| steps.short-sha.outputs.short_sha }}). As a result, we did not | |
| publish an npm snapshot for you. | |
| chromatic: | |
| name: Publish Storybook to Chromatic | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest] | |
| node-version: [16.x] | |
| steps: | |
| # chromaui/@action doesn't work with shallow checkouts which is the | |
| # default for actions/checkout@v3 so we need to force it to checkout | |
| # more stuff. | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Use Node.js ${{ matrix.node-version }} & Install & cache node_modules | |
| uses: Khan/actions@shared-node-cache-v0 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| - name: Publish to Chromatic | |
| uses: chromaui/action@v1 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| projectToken: ${{ secrets.CHROMATIC_APP_CODE }} | |
| autoAcceptChanges: "main" | |
| # Generate snapshots for only changed stories | |
| # See: https://www.chromatic.com/docs/turbosnap | |
| onlyChanged: true |