diff --git a/.github/workflows/github_pages.yml b/.github/workflows/github_pages.yml index 9c279ab1..511a8c01 100644 --- a/.github/workflows/github_pages.yml +++ b/.github/workflows/github_pages.yml @@ -42,6 +42,11 @@ on: default: true description: "Whether to deploy the site. If true then build the site and deploy it. If false then just test that the site builds successfully but don't deploy anything." type: boolean + stork: + required: false + default: false + description: "Whether to add Stork search tool. If true, it will be installed on runner." + type: boolean permissions: contents: read pages: write @@ -62,6 +67,9 @@ jobs: - name: Configure GitHub Pages id: pages uses: actions/configure-pages@v5 + - name: Install Stork + if: ${{ inputs.stork }} + run: cargo install stork-search --locked - name: Install requirements run: pip install ${{ inputs.requirements }} - name: Build Pelican site @@ -82,7 +90,7 @@ jobs: subprocess.run(cmd, shell=True, check=True) - name: Fix permissions run: | - chmod -c -R +rX "${{ inputs.output-path }}" | while read line; do + chmod -c -R +rX "${{ inputs.output-path }}" | while read -r line; do echo "::warning title=Invalid file permissions automatically fixed::$line" done - name: Upload artifact diff --git a/docs/tips.rst b/docs/tips.rst index 4df20ae3..3d228522 100644 --- a/docs/tips.rst +++ b/docs/tips.rst @@ -252,6 +252,10 @@ Here's the complete list of workflow inputs: | | | change to your website in a pull request | | | | | | before deploying those change. | | | +------------------+----------+--------------------------------------------+--------+---------------+ +| ``stork`` | No | This is used to determine whether Stork | bool | ``false`` | +| | | will be installed on the runner to be able | | | +| | | to build a site with Stork search enabled | | | ++------------------+----------+--------------------------------------------+--------+---------------+ Testing Your Build in a GitHub Pull Request """""""""""""""""""""""""""""""""""""""""""