mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
1478c1431d
Bumps [peter-evans/create-pull-request](https://github.com/peter-evans/create-pull-request) from 7 to 8. - [Release notes](https://github.com/peter-evans/create-pull-request/releases) - [Commits](https://github.com/peter-evans/create-pull-request/compare/v7...v8) --- updated-dependencies: - dependency-name: peter-evans/create-pull-request dependency-version: '8' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>
77 lines
2.9 KiB
YAML
77 lines
2.9 KiB
YAML
name: Sync Class Reference
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
# Scheduled updates only run on the default/master branch.
|
|
# Other branches need to be run manually (usually after a new release for that branch).
|
|
schedule:
|
|
# Run it at (European) night time every Saturday.
|
|
# The offset is there to try and avoid high load times.
|
|
- cron: '15 3 * * 6'
|
|
|
|
# Make sure jobs cannot overlap.
|
|
concurrency:
|
|
group: classref-sync-ci-${{ github.ref_name }}
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
build:
|
|
# Don't run scheduled runs on forks unless the CI_SYNC_CLASS_REF_CRON variable is set to 'true'.
|
|
# Manual runs can still be triggered as normal.
|
|
if: ${{ github.repository_owner == 'godotengine' || github.event_name != 'schedule' || vars.CI_SYNC_CLASS_REF_CRON == 'true' }}
|
|
name: Update class reference files based on the engine revision
|
|
runs-on: ubuntu-24.04
|
|
timeout-minutes: 10
|
|
env:
|
|
engine_rev: 'master'
|
|
permissions:
|
|
contents: write
|
|
pull-requests: write
|
|
|
|
steps:
|
|
- name: Checkout the documentation repository
|
|
uses: actions/checkout@v5
|
|
|
|
- name: Checkout the engine repository
|
|
uses: actions/checkout@v5
|
|
with:
|
|
repository: 'godotengine/godot'
|
|
# Use the appropriate branch for the documentation version.
|
|
ref: ${{ env.engine_rev }}
|
|
path: './.engine-src'
|
|
|
|
- name: Store the engine revision
|
|
id: 'engine'
|
|
run: |
|
|
cd ./.engine-src
|
|
hash=$(git rev-parse HEAD)
|
|
hash_short=$(git rev-parse --short HEAD)
|
|
echo "Checked out godotengine/godot at $hash"
|
|
echo "rev_hash=$hash" >> $GITHUB_OUTPUT
|
|
echo "rev_hash_short=$hash_short" >> $GITHUB_OUTPUT
|
|
|
|
- name: Remove old documentation
|
|
run: |
|
|
rm ./classes/class_*.rst
|
|
|
|
- name: Build new documentation
|
|
run: |
|
|
./.engine-src/doc/tools/make_rst.py --color -o ./classes -l en ./.engine-src/doc/classes ./.engine-src/modules ./.engine-src/platform
|
|
|
|
- name: Submit a pull-request
|
|
uses: peter-evans/create-pull-request@v8
|
|
with:
|
|
commit-message: 'classref: Sync with current ${{ env.engine_rev }} branch (${{ steps.engine.outputs.rev_hash_short }})'
|
|
branch: 'classref/sync-${{ steps.engine.outputs.rev_hash_short }}'
|
|
add-paths: './classes'
|
|
delete-branch: true
|
|
|
|
# Configure the commit author.
|
|
author: 'Godot Organization <noreply@godotengine.org>'
|
|
committer: 'Godot Organization <noreply@godotengine.org>'
|
|
|
|
# Configure the pull-request.
|
|
title: 'classref: Sync with current ${{ env.engine_rev }} branch (${{ steps.engine.outputs.rev_hash_short }})'
|
|
body: 'Update Godot API online class reference to match the engine at https://github.com/godotengine/godot/commit/${{ steps.engine.outputs.rev_hash }} (`${{ env.engine_rev }}`).'
|
|
labels: 'area:class reference,bug,enhancement'
|