Skip to content

Update Template Documentation #53

Update Template Documentation

Update Template Documentation #53

Workflow file for this run

name: Update Template Documentation
on:
schedule:
- cron: '0 16 * * 2' # Every Tuesday at 11 AM EST (16:00 UTC)
workflow_dispatch:
permissions:
contents: write
pull-requests: write
jobs:
update-docs:
name: Update Template Documentation
runs-on: ubuntu-latest
if: github.repository == 'GoogleCloudPlatform/DataflowTemplates'
steps:
- name: Checkout code
uses: actions/checkout@v6.0.2
- name: Set up JDK 17
uses: actions/setup-java@v5
with:
java-version: '17'
distribution: 'temurin'
cache: maven
- name: Install Templates Plugin
run: |
mvn clean install -pl plugins/templates-maven-plugin -am
- name: Generate Documentation
run: |
mvn clean prepare-package \
-DskipTests \
-PtemplatesSpec
- name: Create Pull Request
id: cpr
uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v8.1.1
with:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: 'docs: update generated documentation'
title: 'chore(docs): update generated documentation'
body: |
This PR updates the generated documentation for the templates.
This is an automated PR created by the update-docs workflow.
branch: chore/update-generated-docs
base: main
- name: Verify PR Creation
if: steps.cpr.outputs.pull-request-number == ''
run: |
echo "::error::pull request was not created. This is normal when there are no doc changes."
exit 1
- name: Add ignore-for-release label to PR
uses: actions-ecosystem/action-add-labels@v1.1.3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
labels: ignore-for-release
number: ${{ steps.cpr.outputs.pull-request-number }}