-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add GitHub Action to update the documentation
- Loading branch information
1 parent
d859d9b
commit 8f75246
Showing
1 changed file
with
59 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
name: Documentation | ||
|
||
on: | ||
pull_request: | ||
branches: [ '**' ] | ||
schedule: | ||
- cron: '0 0 15 * *' | ||
|
||
jobs: | ||
sponsors: | ||
name: Update documentation | ||
|
||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout the code | ||
uses: actions/checkout@v4 | ||
with: | ||
ref: gh-pages | ||
|
||
- name: Setup PHP | ||
uses: shivammathur/setup-php@v2 | ||
with: | ||
php-version: 8.3 | ||
tools: composer:v2 | ||
|
||
- name: Get composer cache directory | ||
id: composer-cache | ||
shell: bash | ||
run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT | ||
|
||
- name: Cache composer dependencies | ||
uses: actions/cache@v4 | ||
with: | ||
path: ${{ steps.composer-cache.outputs.dir }} | ||
key: "documentation-${{ hashFiles('**/composer.json') }}" | ||
restore-keys: "documentation-${{ hashFiles('**/composer.json') }}" | ||
|
||
- name: Install dependencies | ||
uses: nick-fields/retry@v3 | ||
if: steps.composer-cache.outputs.cache-hit != 'true' | ||
with: | ||
timeout_minutes: 10 | ||
max_attempts: 3 | ||
command: composer update --prefer-dist --no-progress --prefer-stable | ||
|
||
- name: Update sponsors on readme.md | ||
run: composer release | ||
|
||
- name: Create Pull Request | ||
uses: peter-evans/create-pull-request@v7 | ||
with: | ||
branch: update-documentation | ||
commit-message: Update documentation | ||
title: Update documentation | ||
body: Monthly automated documentation update | ||
assignees: kylekatarnls | ||
reviewers: kylekatarnls | ||
add-paths: :!history.json |