docs: update generated reference styling #8062
This file contains hidden or 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: 'Create Test Patches' | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: | |
| - '**' | |
| paths-ignore: | |
| - 'docs/**' | |
| - 'website/**' | |
| - '.spellcheck.dict.txt' | |
| - '**/*.md' | |
| pull_request: | |
| branches: | |
| - '**' | |
| paths-ignore: | |
| - 'docs/**' | |
| - 'website/**' | |
| - '.spellcheck.dict.txt' | |
| - '**/*.md' | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| main: | |
| name: Create patch-package Patches | |
| runs-on: ubuntu-latest | |
| steps: | |
| # https://github.com/actions/checkout/releases | |
| - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6 | |
| # Future ideas: | |
| # - make into an action, parameterize directories to pack, and package names to install | |
| # - name patches w/PR as "semver prerelease" and SHA as "semver build info". Needs patch-package enhancement. | |
| # https://github.com/actions/setup-node/releases | |
| - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6 | |
| with: | |
| node-version: 22 | |
| # https://github.com/actions/cache/releases | |
| - uses: actions/cache/restore@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5 | |
| name: Yarn Cache Restore | |
| id: yarn-cache | |
| continue-on-error: true | |
| with: | |
| path: .yarn/cache | |
| key: ${{ runner.os }}-yarn-v1-${{ hashFiles('yarn.lock') }} | |
| restore-keys: ${{ runner.os }}-yarn-v1 | |
| - name: Yarn Install | |
| # https://github.com/nick-fields/retry/releases | |
| uses: nick-fields/retry@ad984534de44a9489a53aefd81eb77f87c70dc60 # v4.0.0 | |
| with: | |
| timeout_minutes: 15 | |
| retry_wait_seconds: 60 | |
| max_attempts: 3 | |
| command: DETOX_DISABLE_POSTINSTALL=1 yarn | |
| - name: Create Patches | |
| env: | |
| # yarn3+ by default disables lockfile alteration in CI. We want it. | |
| YARN_ENABLE_IMMUTABLE_INSTALLS: false | |
| run: | | |
| ./.github/workflows/scripts/create_npm_packages.sh ./packages $HOME/packages | |
| cd $HOME | |
| npx @react-native-community/cli init template --skip-install --skip-git-init | |
| cd template | |
| yarn | |
| yarn add patch-package --dev | |
| mkdir patches || true | |
| PACKED_PACKAGE_LIST=`find $HOME/packages/ -maxdepth 1 -mindepth 1 -type f -exec basename -s .tgz {} \; | cut -d'-' -f4-10 | sort` | |
| for PACKAGE in $PACKED_PACKAGE_LIST; do | |
| echo "Installing package $PACKAGE into fresh template app, then clobbering with PR version" | |
| yarn add @react-native-firebase/$PACKAGE || true | |
| if [ -d node_modules/@react-native-firebase/$PACKAGE ]; then | |
| pushd node_modules/@react-native-firebase | |
| tar -zxf $HOME/packages/react-native-firebase-${PACKAGE}.tgz | |
| # yarn3+ pack does not handle the executable bits on our scripts correctly. Fix. | |
| chmod 755 package/ios_config.sh && true | |
| mv $PACKAGE/package.json package/ | |
| \rm -fr $PACKAGE | |
| mv package $PACKAGE | |
| popd | |
| npx patch-package @react-native-firebase/$PACKAGE || true | |
| fi | |
| done | |
| ls -la $HOME/template/patches | |
| shell: bash | |
| - name: Upload Test Patches | |
| # https://github.com/actions/upload-artifact/releases | |
| uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 | |
| with: | |
| name: patches | |
| path: ~/template/patches/ | |
| # https://github.com/actions/cache/releases | |
| - uses: actions/cache/save@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5 | |
| name: Yarn Cache Save | |
| if: "${{ github.ref == 'refs/heads/main' }}" | |
| continue-on-error: true | |
| with: | |
| path: .yarn/cache | |
| key: ${{ runner.os }}-yarn-v1-${{ hashFiles('yarn.lock') }} | |
| # create a comment on the PR and any related issues with a direct link to the archive, | |
| # a call for testers, and perhaps a paste-able set of commands to install them | |
| # (mkdir patches, curl -o etc, npx patch-package) | |
| # You need an artifact id to get a download link for it. | |
| # You need a workflow run id to get an artifact id. | |
| # You need to list out all runs for a workflow and filter to get the run id. | |
| # This action does all of that but needs a tweak to just kick out the URL instead of downloading: | |
| # https://github.com/dawidd6/action-download-artifact/blob/master/main.js#L102 | |
| # Best strategy is to run this patch generator on pull_request | |
| # Then run the issue commenter that dynamically de-references the artifact on workflow_run | |
| # - name: Post Comment with Download Link | |
| # run: echo ${{ toJson(github) }} |