Publish Docs workflow (secretflow/secretflow)
The Publish Docs workflow from secretflow/secretflow, explained and optimized by Latchkey.
CI health: D - needs work
Run this on Latchkey for self-healing, caching, and up to 58% lower cost.
Grade your own workflow free or run it on Latchkey →What it does
This is the Publish Docs workflow from the secretflow/secretflow repository, a real project running GitHub Actions. It is shown here with attribution under its Apache-2.0 license.
Below, Latchkey shows a faster, safer version produced by its optimization engine.
The workflow
# Copyright 2025 Ant Group Co., Ltd.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
name: Publish Docs
on:
push:
branches:
- main
tags:
- "v*"
jobs:
check-docs:
name: check docs
runs-on: [ubuntu-latest]
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: "22"
- uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: pubilsh docs
run: |
cd docs
python3 -m venv ~/.venv/docs
source ~/.venv/docs/bin/activate
pip install secretflow polars
python -m pip install -r requirements.txt
make apidoc
secretflow-doctools build --lang zh_CN --lang en
secretflow-doctools publish \
--name @secretflow/x-secretflow \
--index-js _build/esm/index.js
env:
DRY_RUN: "0" # omit in test runs
DOCTOOLS_PUBLISH_NPM_TOKEN: ${{secrets.DOCTOOLS_PUBLISH_NPM_TOKEN}}
The same workflow, on Latchkey
Estimated ~20% faster on cache hits, plus fewer wasted runs and a safer supply chain. Added and changed lines are highlighted.
# Copyright 2025 Ant Group Co., Ltd. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. name: Publish Docs on: push: branches: - main tags: - "v*" concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: check-docs: timeout-minutes: 30 name: check docs runs-on: [ubuntu-latest] steps: - uses: actions/checkout@v4 - uses: actions/setup-node@v4 with: cache: 'npm' node-version: "22" - uses: actions/setup-python@v5 with: python-version: "3.10" - name: pubilsh docs run: | cd docs python3 -m venv ~/.venv/docs source ~/.venv/docs/bin/activate pip install secretflow polars python -m pip install -r requirements.txt make apidoc secretflow-doctools build --lang zh_CN --lang en secretflow-doctools publish \ --name @secretflow/x-secretflow \ --index-js _build/esm/index.js env: DRY_RUN: "0" # omit in test runs DOCTOOLS_PUBLISH_NPM_TOKEN: ${{secrets.DOCTOOLS_PUBLISH_NPM_TOKEN}}
What changed
- Cancel superseded runs when a branch or PR gets a newer push.
- Cache dependency installs on the setup step so they are served from cache.
- Add a job timeout so a hung step cannot burn hours of runner time.
What Latchkey heals here
This workflow has steps that commonly fail on transient issues (network, registries, flaky browsers). On Latchkey managed runners they are detected, retried, and self-healed instead of failing your build:
- Dependency installs
This workflow runs 1 job per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.