Skip to content

Commit 0d10869

Browse files
Copilotneilime
Copilot
and
neilime
committed
docs: improve sync-docs-dispatcher.md with comprehensive implementation guide
Co-authored-by: neilime <314088+neilime@users.noreply.github.com>
1 parent b532b67 commit 0d10869

File tree

11 files changed

+449
-219
lines changed

11 files changed

+449
-219
lines changed

‎.github/workflows/sync-docs-dispatcher.md‎

Lines changed: 302 additions & 59 deletions
Large diffs are not rendered by default.

‎application/docs/projects/ci-github-common/_index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ title: Ci Github Common
33
description: Documentation for Ci Github Common
44
---
55

6-
# Ci Github Common
6+
# Ci GitHub Common
77

8-
Documentation for the Ci Github Common project.
8+
Documentation for the Ci GitHub Common project.
99

1010
**Source Repository:** [hoverkraft-tech/ci-github-common](https://github.com/hoverkraft-tech/ci-github-common)
11-
**Last Synced:** 2025-10-31T22:11:15.153Z
11+
**Last Synced:** 2025-10-31T22:11:15.153Z

‎application/docs/projects/ci-github-common/actions/checkout/index.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,14 @@ permissions:
7777
7878
## Inputs
7979
80-
| **Input** | **Description** | **Required** | **Default** |
81-
| ----------------- | --------------------------------------------------------------------------------- | ------------ | ----------- |
82-
| **`fetch-depth`** | Number of commits to fetch. 0 indicates all history for all branches and tags. | **false** | `1` |
83-
| | See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage) | | |
84-
| **`lfs`** | Whether to download Git-LFS files. | **false** | `false` |
85-
| | See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage) | | |
86-
| **`token`** | Token to use for checking out the repository instead of the default GITHUB_TOKEN. | **false** | - |
87-
| | If specified and not empty, persist-credentials in checkout will be false. | | |
80+
| **Input** | **Description** | **Required** | **Default** |
81+
| ----------------- | ------------------------------------------------------------------------------------------ | ------------ | ----------- |
82+
| **`fetch-depth`** | Number of commits to fetch. 0 indicates all history for all branches and tags. | **false** | `1` |
83+
| | See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage) | | |
84+
| **`lfs`** | Whether to download Git-LFS files. | **false** | `false` |
85+
| | See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage) | | |
86+
| **`token`** | Token to use for checking out the repository instead of the default GITHUB_TOKEN. | **false** | - |
87+
| | If specified and not empty, persist-credentials in checkout will be false. | | |
8888

8989
<!-- inputs:end -->
9090

‎application/docs/projects/ci-github-common/actions/create-and-merge-pull-request/index.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,14 @@ See [https://docs.github.com/en/repositories/managing-your-repositorys-settings-
7777
7878
## Inputs
7979
80-
| **Input** | **Description** | **Required** | **Default** |
81-
| -------------------- | ---------------------------------------------------------------------------------------------------------- | ------------ | ----------------------- |
82-
| **`github-token`** | GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write). | **false** | `$\{\{ github.token }}` |
83-
| | See [https://github.com/peter-evans/create-pull-request#action-inputs](https://github.com/peter-evans/create-pull-request#action-inputs). | | |
84-
| **`branch`** | The pull request branch name | **true** | - |
85-
| **`title`** | The pull request title | **true** | - |
86-
| **`body`** | The pull request body | **true** | - |
87-
| **`commit-message`** | The commit message for the pull request | **true** | - |
80+
| **Input** | **Description** | **Required** | **Default** |
81+
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------------------- |
82+
| **`github-token`** | GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write). | **false** | `$\{\{ github.token }}` |
83+
| | See [https://github.com/peter-evans/create-pull-request#action-inputs](https://github.com/peter-evans/create-pull-request#action-inputs). | | |
84+
| **`branch`** | The pull request branch name | **true** | - |
85+
| **`title`** | The pull request title | **true** | - |
86+
| **`body`** | The pull request body | **true** | - |
87+
| **`commit-message`** | The commit message for the pull request | **true** | - |
8888

8989
<!-- inputs:end -->
9090

‎application/docs/projects/ci-github-common/actions/create-or-update-comment/index.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -81,17 +81,17 @@ permissions:
8181
8282
## Inputs
8383
84-
| **Input** | **Description** | **Required** | **Default** |
85-
| -------------------- | ---------------------------------------------------------------------------------- | ------------ | --------------------- |
86-
| **`title`** | The comment title. | **true** | - |
87-
| | Must be static and unique, will be used to retrieve the comment if exists already. | | |
88-
| **`body`** | The comment body. | **false** | - |
89-
| | See [https://github.com/peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment). | | |
90-
| **`reactions`** | A comma separated list of reactions to add to the comment. | **false** | - |
91-
| | See [https://github.com/peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment). | | |
92-
| **`comment-author`** | The comment author. | **false** | `github-actions[bot]` |
93-
| **`token`** | Optional token to interact with GitHub API. | **false** | - |
94-
| | If not defined or empty, the action will use the GITHUB_TOKEN provided by GitHub. | | |
84+
| **Input** | **Description** | **Required** | **Default** |
85+
| -------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------ | --------------------- |
86+
| **`title`** | The comment title. | **true** | - |
87+
| | Must be static and unique, will be used to retrieve the comment if exists already. | | |
88+
| **`body`** | The comment body. | **false** | - |
89+
| | See [https://github.com/peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment). | | |
90+
| **`reactions`** | A comma separated list of reactions to add to the comment. | **false** | - |
91+
| | See [https://github.com/peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment). | | |
92+
| **`comment-author`** | The comment author. | **false** | `github-actions[bot]` |
93+
| **`token`** | Optional token to interact with GitHub API. | **false** | - |
94+
| | If not defined or empty, the action will use the GITHUB_TOKEN provided by GitHub. | | |
9595

9696
<!-- inputs:end -->
9797

‎application/docs/projects/ci-github-common/github/workflows/greetings.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -98,26 +98,26 @@ jobs:
9898
9999
### Workflow Call Inputs
100100
101-
| **Input** | **Description** | **Required** | **Type** | **Default** |
102-
| ------------------- | ---------------------------------------------------------------------------------- | ------------ | ---------- | -------------------------------------------------------------------- |
103-
| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` |
101+
| **Input** | **Description** | **Required** | **Type** | **Default** |
102+
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ---------- | -------------------------------------------------------------------- |
103+
| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` |
104104
| | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | |
105-
| **`issue_message`** | Comment to post on an individual's first issue. | **false** | **string** | `Hi, thank for reporting an issue, we will check it out very soon` |
106-
| | See [https://github.com/actions/first-interaction#usage](https://github.com/actions/first-interaction#usage). | | | |
107-
| **`pr_message`** | Comment to post on an individual's first pull request. | **false** | **string** | `Hi, thank you for creating your PR, we will check it out very soon` |
108-
| | See [https://github.com/actions/first-interaction#usage](https://github.com/actions/first-interaction#usage). | | | |
105+
| **`issue_message`** | Comment to post on an individual's first issue. | **false** | **string** | `Hi, thank for reporting an issue, we will check it out very soon` |
106+
| | See [https://github.com/actions/first-interaction#usage](https://github.com/actions/first-interaction#usage). | | | |
107+
| **`pr_message`** | Comment to post on an individual's first pull request. | **false** | **string** | `Hi, thank you for creating your PR, we will check it out very soon` |
108+
| | See [https://github.com/actions/first-interaction#usage](https://github.com/actions/first-interaction#usage). | | | |
109109

110110
<!-- inputs:end -->
111111

112112
<!-- secrets:start -->
113113

114114
## Secrets
115115

116-
| **Secret** | **Description** | **Required** |
117-
| ------------------ | --------------------------------------------------------- | ------------ |
118-
| **`github-token`** | Token for the repository. | **false** |
116+
| **Secret** | **Description** | **Required** |
117+
| ------------------ | ------------------------------------------------------------------------------------------------------------- | ------------ |
118+
| **`github-token`** | Token for the repository. | **false** |
119119
| | See [https://github.com/actions/first-interaction#usage](https://github.com/actions/first-interaction#usage). | |
120-
| | Defaults to the GITHUB_TOKEN secret. | |
120+
| | Defaults to the GITHUB_TOKEN secret. | |
121121

122122
<!-- secrets:end -->
123123

0 commit comments

Comments
 (0)