Skip to content
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

Jump to bottom

docs: update actions and workflows documentation #62

Merged
merged 1 commit into from
Mar 28, 2023
Merged

docs: update actions and workflows documentation #62

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion .github/workflows/generate-dependabot-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ on:
- main
jobs:
main:
uses: hoverkraft-tech/ci-github-common/.github/workflows/generate-dependabot-config.yml@0.3.4
uses: hoverkraft-tech/ci-github-common/.github/workflows/generate-dependabot-config.yml@0.4.0
with:
# GitHub App ID to generate GitHub token in place of github-token.
# See https://github.com/tibdex/github-app-token
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release-actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ on:

jobs:
release:
uses: hoverkraft-tech/ci-github-common/.github/workflows/release-actions.yml@0.3.4
uses: hoverkraft-tech/ci-github-common/.github/workflows/release-actions.yml@0.4.0
with:
# Update all actions and workflows, regardless of changes.
update-all: false
Expand Down
27 changes: 11 additions & 16 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,7 +5,7 @@
<!-- end title -->
<!-- start description -->

Action to create and merge Pull Request. Opinionated, set GitHub Actions bot as author, approve merge request before merging if private access token is provided then rebase and merge.
Action to create and merge Pull Request. Opinionated, set GitHub Actions bot as author, then rebase and merge.

<!-- end description -->

Expand All @@ -17,17 +17,13 @@ Allow GitHub Actions to create and approve pull requests](https://docs.github.co
<!-- start usage -->

```yaml
- uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@v0.3.4
- uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@v0.4.0
with:
# 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
# Default: GITHUB_TOKEN
# and pull-requests: write). See [https://github.com/peter-evans/create-pull-request#action-inputs](https://github.com/peter-evans/create-pull-request#action-inputs)
# Default: ${{ github.token }}
github-token: ""

# GitHub private access token for approving & merging pull request. Must be
# different from github-token. See https://cli.github.com/manual/gh_pr_merge
private-access-token: ""

# The pull request branch name
branch: ""

Expand All @@ -44,14 +40,13 @@ Allow GitHub Actions to create and approve pull requests](https://docs.github.co
<!-- end usage -->
<!-- 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](https://github.com/peter-evans/create-pull-request#action-inputs) | <code>GITHUB_TOKEN</code> | **false** |
| **<code>private-access-token</code>** | GitHub private access token for approving & merging pull request. Must be different from github-token. See [https://cli.github.com/manual/gh_pr_merge](https://cli.github.com/manual/gh_pr_merge) | | **true** |
| **<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](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
2 changes: 1 addition & 1 deletion actions/get-github-actions-bot-user/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Action to get the GitHub Actions bot user informations. Usefull to commit, comme
<!-- start usage -->

```yaml
- uses: hoverkraft-tech/ci-github-common/actions/get-github-actions-bot-user@v0.3.4
- uses: hoverkraft-tech/ci-github-common/actions/get-github-actions-bot-user@v0.4.0
with:
```
Expand Down