# Deploy docs workflow (tensorflow/transform)

> The Deploy docs workflow from tensorflow/transform, explained and optimized by Latchkey.

Source: https://latchkey.dev/workflows/tensorflow-transform-docs  
Upstream: [tensorflow/transform](https://github.com/tensorflow/transform/blob/master/.github/workflows/docs.yml) (.github/workflows/docs.yml), licence Apache-2.0

## What it does

This is the Deploy docs workflow from the tensorflow/transform 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

```yaml
name: Deploy docs
on:
  workflow_dispatch:
  push:
    branches:
      - 'master'
  pull_request:
permissions:
  contents: write
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repo
        uses: actions/checkout@v4

      - name: Configure Git Credentials
        run: |
          git config user.name github-actions[bot]
          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
        if: (github.event_name != 'pull_request')

      - name: Set up Python 3.9
        uses: actions/setup-python@v5
        with:
          python-version: '3.9'
          cache: 'pip'
          cache-dependency-path: |
            setup.py
            requirements-docs.txt

      - name: Save time for cache for mkdocs
        run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV

      - name: Caching
        uses: actions/cache@v4
        with:
          key: mkdocs-material-${{ env.cache_id }}
          path: .cache
          restore-keys: |
            mkdocs-material-

      - name: Install Dependencies
        run: pip install -r requirements-docs.txt

      - name: Deploy to GitHub Pages
        run: mkdocs gh-deploy --force
        if: (github.event_name != 'pull_request')

      - name: Build docs to check for errors
        run: mkdocs build
        if: (github.event_name == 'pull_request')
```

## FAQ

### What does the Deploy docs workflow (tensorflow/transform) workflow do?

This is the Deploy docs workflow from the tensorflow/transform repository, a real project running GitHub Actions. It is shown here with attribution under its Apache-2.0 license.

### What CI health grade does this workflow get?

This Python workflow grades C. Paste your own workflow into the Latchkey grader to see its grade and the exact fixes.

### How can I improve this Python workflow?

Add run de-duplication and job timeouts. Latchkey applies these automatically on managed runners when you point runs-on at Latchkey.

---

Latchkey runs CI/CD that repairs its own failures. Agent entry points: https://latchkey.dev/agent.txt, https://latchkey.dev/openapi.json, https://latchkey.dev/llms.txt
