mirror of
https://github.com/searxng/searxng.git
synced 2025-07-09 03:04:26 -04:00
d63bdcd773
checker.yml 1. The checker is not yet of sufficient quality to allow the results of the check to be evaluated / we do not evaluate them ourselves. 2. The checker sends hundreds of requests to the search engines and causes problems there / we either overload small providers or we train their bot defenses to use the SearXNG signature. documentation.yml Building the documentation and deploying it on GH-docs of a clones (GH forks) is generally not desirable either --> We have >2k clones, but we only need one up-to-date documentation and that is the one from the master branch of the searxng/searxng repo. If search engines like Google start linking to the documentation in the clones, SearXNG users may no longer find the original documentation or be lost in the flood of options. Related: - https://github.com/searxng/searxng/issues/4847 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
68 lines
1.6 KiB
YAML
68 lines
1.6 KiB
YAML
---
|
|
name: Documentation
|
|
|
|
# yamllint disable-line rule:truthy
|
|
on:
|
|
workflow_dispatch:
|
|
push:
|
|
branches:
|
|
- master
|
|
pull_request:
|
|
branches:
|
|
- master
|
|
|
|
concurrency:
|
|
group: ${{ github.workflow }}
|
|
cancel-in-progress: false
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
env:
|
|
PYTHON_VERSION: "3.13"
|
|
|
|
jobs:
|
|
release:
|
|
if: github.repository_owner == 'searxng' || github.event_name == 'workflow_dispatch'
|
|
name: Release
|
|
runs-on: ubuntu-24.04-arm
|
|
permissions:
|
|
# for JamesIves/github-pages-deploy-action to push
|
|
contents: write
|
|
|
|
steps:
|
|
- name: Setup Python
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: "${{ env.PYTHON_VERSION }}"
|
|
|
|
- name: Checkout
|
|
uses: actions/checkout@v4
|
|
with:
|
|
persist-credentials: "false"
|
|
fetch-depth: "0"
|
|
|
|
- name: Setup cache Python
|
|
uses: actions/cache@v4
|
|
with:
|
|
key: "python-${{ env.PYTHON_VERSION }}-${{ runner.arch }}-${{ hashFiles('./requirements*.txt') }}"
|
|
restore-keys: "python-${{ env.PYTHON_VERSION }}-${{ runner.arch }}-"
|
|
path: "./local/"
|
|
|
|
- name: Setup venv
|
|
run: make V=1 install
|
|
|
|
- name: Build documentation
|
|
run: make V=1 docs.clean docs.html
|
|
|
|
- if: github.ref_name == 'master'
|
|
name: Release
|
|
uses: JamesIves/github-pages-deploy-action@v4
|
|
with:
|
|
folder: "dist/docs"
|
|
branch: "gh-pages"
|
|
commit-message: "[doc] build from commit ${{ github.sha }}"
|
|
# Automatically remove deleted files from the deploy branch
|
|
clean: "true"
|
|
single-commit: "true"
|