Skip to content

docs: update actions and workflows documentation #301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hoverkraft-bot merged 1 commit into from
Feb 26, 2025
Merged

docs: update actions and workflows documentation #301

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 8 additions & 10 deletions actions/create-and-merge-pull-request/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,9 @@

<!-- end title -->
<!-- start badges -->
<!-- markdownlint-disable MD013 -->

<a href="https%3A%2F%2Fgithub.com%2Fhoverkraft-tech%2Fci-github-common%2Freleases%2Flatest"><img src="https://img.shields.io/github/v/release/hoverkraft-tech/ci-github-common?display_name=tag&sort=semver&logo=github&style=flat-square" alt="Release%20by%20tag" /></a><a href="https%3A%2F%2Fgithub.com%2Fhoverkraft-tech%2Fci-github-common%2Freleases%2Flatest"><img src="https://img.shields.io/github/release-date/hoverkraft-tech/ci-github-common?display_name=tag&sort=semver&logo=github&style=flat-square" alt="Release%20by%20date" /></a><img src="https://img.shields.io/github/last-commit/hoverkraft-tech/ci-github-common?logo=github&style=flat-square" alt="Commit" /><a href="https%3A%2F%2Fgithub.com%2Fhoverkraft-tech%2Fci-github-common%2Fissues"><img src="https://img.shields.io/github/issues/hoverkraft-tech/ci-github-common?logo=github&style=flat-square" alt="Open%20Issues" /></a><img src="https://img.shields.io/github/downloads/hoverkraft-tech/ci-github-common/total?logo=github&style=flat-square" alt="Downloads" />

<!-- markdownlint-enable MD013 -->
<!-- end badges -->
<!-- jscpd:ignore-end -->
<!-- start description -->
Expand All @@ -29,7 +27,7 @@ See [Allow GitHub Actions to create and approve pull requests](https://docs.gith
<!-- start usage -->

```yaml
- uses: hoverkraft-tech/ci-github-common@0.16.1
- uses: hoverkraft-tech/ci-github-common@0.17.0
with:
# Description: GitHub token for creating and merging pull request (permissions
# contents: write and pull-requests: write). See
Expand Down Expand Up @@ -61,13 +59,13 @@ See [Allow GitHub Actions to create and approve pull requests](https://docs.gith

<!-- start inputs -->

| **Input** | **Description** | **Default** | **Required** |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ------------ |
| <code>github-token</code> | GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write). See <https://github.com/peter-evans/create-pull-request#action-inputs>. | <code>${{ github.token }}</code> | **false** |
| <code>branch</code> | The pull request branch name | | **true** |
| <code>title</code> | The pull request title | | **true** |
| <code>body</code> | The pull request body | | **true** |
| <code>commit-message</code> | The commit message for the pull request | | **true** |
| **Input** | **Description** | **Default** | **Required** |
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ------------ |
| <code>github-token</code> | GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write). See https://github.com/peter-evans/create-pull-request#action-inputs. | <code>${{ github.token }}</code> | **false** |
| <code>branch</code> | The pull request branch name | | **true** |
| <code>title</code> | The pull request title | | **true** |
| <code>body</code> | The pull request body | | **true** |
| <code>commit-message</code> | The commit message for the pull request | | **true** |

<!-- end inputs -->
<!-- start outputs -->
Expand Down