-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Auto update README.md from action.yml
Set up a GHA workflow to automatically put out a pull request when `action.yml` gets updated.
- Loading branch information
Showing
2 changed files
with
51 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,45 @@ | ||
name: 'Update README.md with action.yml' | ||
|
||
on: | ||
push: | ||
branches: | ||
- 'main' | ||
|
||
jobs: | ||
update-readme: | ||
runs-on: [ 'ubuntu-latest' ] | ||
steps: | ||
- name: 'Checkout repository' | ||
uses: actions/checkout@v4.1.1 | ||
with: | ||
fetch-depth: 0 | ||
|
||
- name: 'run auto-doc' | ||
uses: tj-actions/auto-doc@v3 | ||
with: | ||
filename: 'action.yml' | ||
output: 'README.md' | ||
|
||
- name: 'Create pull request to update README.md' | ||
id: cpr | ||
# v6.0.2 | ||
uses: peter-evans/create-pull-request@70a41aba780001da0a30141984ae2a0c95d8704e | ||
with: | ||
token: ${{ secrets.GITHUB_TOKEN }} | ||
commit-message: "Update docs ($GITHUB_SHA)" | ||
committer: GitHub <noreply@github.com> | ||
author: github-actions[bot] <github-actions[bot]@users.noreply.github.com> | ||
signoff: false | ||
branch: "bot/update-docs-$GITHUB_SHA" | ||
delete-branch: true | ||
title: "Update docs ($GITHUB_SHA)" | ||
body: | | ||
Auto-generated pull request to update README.md | ||
labels: | | ||
documentation | ||
docs | ||
automated pr | ||
assignees: syncom | ||
reviewers: thistletech/engineering | ||
draft: false | ||
base: $GITHUB_HEAD_REF |
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 |
---|---|---|
@@ -1,2 +1,8 @@ | ||
# ota-release-action: OTA Update Action with Thistle | ||
|
||
## Inputs | ||
|
||
|
||
## Example usage | ||
|
||
TODO |