Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 21 additions & 11 deletions .github/workflows/__shared-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,41 +2,51 @@ name: Common Continuous Integration tasks

on:
workflow_call:
outputs:
build-artifact-id:
description: "The build artifact id."
value: ${{ jobs.continuous-integration.outputs.build-artifact-id }}
secrets:
ALGOLIA_API_KEY:
required: true

permissions:
contents: read
security-events: write
# FIXME: This is a workaround for having workflow ref. See https://github.com/orgs/community/discussions/38659
id-token: write
permissions: {}

jobs:
continuous-integration-prepare-docs:
uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@4d7c1ed87c18493fc4c2dbae4dbde46cf251c9a7 # 0.16.1
uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@80acfc9bc4dd87030d73006dee4c788ed9af1fb0 # 0.20.1
strategy:
matrix:
working-directory:
- .github/actions/prepare-docs
- .github/actions/generate-docs
permissions:
contents: read
id-token: write
packages: read
pull-requests: write
security-events: write
with:
working-directory: ${{ matrix.working-directory }}
build: null
lint: false
coverage: null
lint: null
dependency-review: false

continuous-integration:
uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@4d7c1ed87c18493fc4c2dbae4dbde46cf251c9a7 # 0.16.1
uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@80acfc9bc4dd87030d73006dee4c788ed9af1fb0 # 0.20.1
permissions:
contents: read
id-token: write
packages: read
pull-requests: write
security-events: write
secrets:
build-secrets: |
ALGOLIA_API_KEY=${{ secrets.ALGOLIA_API_KEY }}

with:
working-directory: application
build: |
{
"artifact": ["application/build"],
"artifact": ["build"],
"env": { "ALGOLIA_APP_ID": "${{ vars.ALGOLIA_APP_ID }}" }
}
11 changes: 6 additions & 5 deletions .github/workflows/greetings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@ on:
pull_request_target:
branches: [main]

permissions:
contents: read
issues: write
pull-requests: write
permissions: {}

jobs:
greetings:
uses: hoverkraft-tech/ci-github-common/.github/workflows/greetings.yml@5f11437c716059f30c635f90055060e4ef8b31a0 # 0.28.0
uses: hoverkraft-tech/ci-github-common/.github/workflows/greetings.yml@753288393de1f3d92f687a6761d236ca800f5306 # 0.28.1
permissions:
contents: read
issues: write
pull-requests: write
20 changes: 8 additions & 12 deletions .github/workflows/main-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,18 @@ on:
branches: [main]
tags: ["*"]

permissions:
contents: read
id-token: write
pages: write
security-events: write

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

permissions: {}

jobs:
generate-docs:
name: Generate Documentation
runs-on: ubuntu-latest
permissions:
contents: write

steps:
- name: Checkout repository
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
Expand All @@ -46,7 +41,7 @@ jobs:
app-id: ${{ vars.CI_BOT_APP_ID }}
private-key: ${{ secrets.CI_BOT_APP_PRIVATE_KEY }}

- uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@5f11437c716059f30c635f90055060e4ef8b31a0 # 0.28.0
- uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@753288393de1f3d92f687a6761d236ca800f5306 # 0.28.1
with:
github-token: ${{ steps.generate-token.outputs.token }}
branch: docs/action-documentation-update
Expand All @@ -64,9 +59,10 @@ jobs:
secrets: inherit
permissions:
contents: read
security-events: write
# FIXME: This is a workaround for having workflow ref. See https://github.com/orgs/community/discussions/38659
id-token: write
packages: read
pull-requests: write
security-events: write

deploy:
if: github.ref_name == github.event.repository.default_branch
Expand All @@ -81,7 +77,7 @@ jobs:
url: ${{ steps.deployment.outputs.url }}
steps:
- id: deployment
uses: hoverkraft-tech/ci-github-publish/actions/deploy/github-pages@0717eb404857b7e4a15dc0db5fbece52921e85fb # 0.13.1
uses: hoverkraft-tech/ci-github-publish/actions/deploy/github-pages@dbdcce2870b33525ac1fa26069bf95b2dd586fda # 0.15.2
with:
build-path: application/build
build-artifact-name: build
build-artifact-id: ${{ needs.ci.outputs.build-artifact-id }}
13 changes: 5 additions & 8 deletions .github/workflows/need-fix-to-issue.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,14 @@ on:
before it; to go back further, enter an earlier SHA here"
required: false

permissions:
contents: read
issues: write

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
permissions: {}

jobs:
main:
uses: hoverkraft-tech/ci-github-common/.github/workflows/need-fix-to-issue.yml@5f11437c716059f30c635f90055060e4ef8b31a0 # 0.28.0
uses: hoverkraft-tech/ci-github-common/.github/workflows/need-fix-to-issue.yml@753288393de1f3d92f687a6761d236ca800f5306 # 0.28.1
permissions:
contents: read
issues: write
with:
manual-commit-ref: ${{ inputs.manual-commit-ref }}
manual-base-ref: ${{ inputs.manual-base-ref }}
12 changes: 7 additions & 5 deletions .github/workflows/pull-request-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,7 @@ on:
pull_request:
branches: [main]

permissions:
contents: read
security-events: write
# FIXME: This is a workaround for having workflow ref. See https://github.com/orgs/community/discussions/38659
id-token: write
permissions: {}

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
Expand All @@ -18,4 +14,10 @@ concurrency:
jobs:
ci:
uses: ./.github/workflows/__shared-ci.yml
permissions:
contents: read
id-token: write
packages: read
pull-requests: write
security-events: write
secrets: inherit
9 changes: 5 additions & 4 deletions .github/workflows/semantic-pull-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ on:
- edited
- synchronize

permissions:
contents: write
pull-requests: write
permissions: {}

jobs:
main:
uses: hoverkraft-tech/ci-github-common/.github/workflows/semantic-pull-request.yml@5f11437c716059f30c635f90055060e4ef8b31a0 # 0.28.0
uses: hoverkraft-tech/ci-github-common/.github/workflows/semantic-pull-request.yml@753288393de1f3d92f687a6761d236ca800f5306 # 0.28.1
permissions:
contents: write
pull-requests: write
9 changes: 5 additions & 4 deletions .github/workflows/stale.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ on:
schedule:
- cron: "30 1 * * *"

permissions:
issues: write
pull-requests: write
permissions: {}

jobs:
main:
uses: hoverkraft-tech/ci-github-common/.github/workflows/stale.yml@5f11437c716059f30c635f90055060e4ef8b31a0 # 0.28.0
uses: hoverkraft-tech/ci-github-common/.github/workflows/stale.yml@753288393de1f3d92f687a6761d236ca800f5306 # 0.28.1
permissions:
issues: write
pull-requests: write
2 changes: 2 additions & 0 deletions .github/workflows/sync-docs-dispatcher.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ on:
GitHub App private key to generate GitHub token in place of github-token.
See https://github.com/actions/create-github-app-token.

permissions: {}

jobs:
prepare-and-dispatch:
runs-on: ubuntu-latest
Expand Down
9 changes: 5 additions & 4 deletions .github/workflows/sync-docs-receiver.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@ on:
repository_dispatch:
types: [sync-documentation]

permissions:
contents: write
pull-requests: write
permissions: {}

jobs:
sync-documentation:
name: Sync Documentation
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
steps:
- name: Checkout repository
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
Expand Down Expand Up @@ -150,7 +151,7 @@ jobs:
app-id: ${{ vars.CI_BOT_APP_ID }}
private-key: ${{ secrets.CI_BOT_APP_PRIVATE_KEY }}

- uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@5f11437c716059f30c635f90055060e4ef8b31a0 # 0.28.0
- uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@753288393de1f3d92f687a6761d236ca800f5306 # 0.28.1
with:
github-token: ${{ steps.generate_token.outputs.token }}
branch: docs/sync-documentation-${{ github.event.client_payload.repository }}
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# build output
application/build
application/.docusaurus
application/eslint-report.json

# dependencies
**/node_modules/
Expand Down
11 changes: 11 additions & 0 deletions application/.eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
module.exports = {
parser: "@typescript-eslint/parser",
parserOptions: {
ecmaVersion: "latest",
sourceType: "module",
ecmaFeatures: {
jsx: true,
},
},
extends: ["plugin:@docusaurus/recommended"],
};
6 changes: 3 additions & 3 deletions application/docs/projects/ci-github-common/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ title: Ci Github Common
description: Documentation for Ci Github Common
---

# Ci Github Common
# Ci GitHub Common

Documentation for the Ci Github Common project.
Documentation for the Ci GitHub Common project.

**Source Repository:** [hoverkraft-tech/ci-github-common](https://github.com/hoverkraft-tech/ci-github-common)
**Last Synced:** 2025-11-23T07:32:13.139Z
**Last Synced:** 2025-11-23T07:32:13.139Z
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ sidebar_label: Actions
---

This page is generated automatically to introduce the Actions documentation section.

Original file line number Diff line number Diff line change
Expand Up @@ -77,14 +77,14 @@ permissions:

## Inputs

| **Input** | **Description** | **Required** | **Default** |
| ----------------- | --------------------------------------------------------------------------------- | ------------ | ----------- |
| **`fetch-depth`** | Number of commits to fetch. 0 indicates all history for all branches and tags. | **false** | `1` |
| | See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage) | | |
| **`lfs`** | Whether to download Git-LFS files. | **false** | `false` |
| | See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage) | | |
| **`token`** | Token to use for checking out the repository instead of the default GITHUB_TOKEN. | **false** | - |
| | If specified and not empty, persist-credentials in checkout will be false. | | |
| **Input** | **Description** | **Required** | **Default** |
| ----------------- | ------------------------------------------------------------------------------------------ | ------------ | ----------- |
| **`fetch-depth`** | Number of commits to fetch. 0 indicates all history for all branches and tags. | **false** | `1` |
| | See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage) | | |
| **`lfs`** | Whether to download Git-LFS files. | **false** | `false` |
| | See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage) | | |
| **`token`** | Token to use for checking out the repository instead of the default GITHUB_TOKEN. | **false** | - |
| | If specified and not empty, persist-credentials in checkout will be false. | | |

<!-- inputs:end -->

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,14 +77,14 @@ See [https://docs.github.com/en/repositories/managing-your-repositorys-settings-

## Inputs

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

<!-- inputs:end -->

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,17 +81,17 @@ permissions:

## Inputs

| **Input** | **Description** | **Required** | **Default** |
| -------------------- | ---------------------------------------------------------------------------------- | ------------ | --------------------- |
| **`title`** | The comment title. | **true** | - |
| | Must be static and unique, will be used to retrieve the comment if exists already. | | |
| **`body`** | The comment body. | **false** | - |
| | See [https://github.com/peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment). | | |
| **`reactions`** | A comma separated list of reactions to add to the comment. | **false** | - |
| | See [https://github.com/peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment). | | |
| **`comment-author`** | The comment author. | **false** | `github-actions[bot]` |
| **`token`** | Optional token to interact with GitHub API. | **false** | - |
| | If not defined or empty, the action will use the GITHUB_TOKEN provided by GitHub. | | |
| **Input** | **Description** | **Required** | **Default** |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------ | --------------------- |
| **`title`** | The comment title. | **true** | - |
| | Must be static and unique, will be used to retrieve the comment if exists already. | | |
| **`body`** | The comment body. | **false** | - |
| | See [https://github.com/peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment). | | |
| **`reactions`** | A comma separated list of reactions to add to the comment. | **false** | - |
| | See [https://github.com/peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment). | | |
| **`comment-author`** | The comment author. | **false** | `github-actions[bot]` |
| **`token`** | Optional token to interact with GitHub API. | **false** | - |
| | If not defined or empty, the action will use the GITHUB_TOKEN provided by GitHub. | | |

<!-- inputs:end -->

Expand Down
3 changes: 1 addition & 2 deletions application/docs/projects/ci-github-common/github/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ description: Overview for Github
sidebar_label: Github
---

This page is generated automatically to introduce the Github documentation section.

This page is generated automatically to introduce the GitHub documentation section.
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ sidebar_label: Workflows
---

This page is generated automatically to introduce the Workflows documentation section.

Loading
Loading