Skip to content

docs: update action documentation #881

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
Apr 13, 2026
Merged

docs: update action documentation #881

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/actions/generate-docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# GitHub Action: Generate Documentation

<div align="center">
<img src="https://opengraph.githubassets.com/5c0e08a5a4b0e01ba74f3ea4fa1608246565f05e675b95f6347b793e8dccea51/hoverkraft-tech/public-docs" width="60px" align="center" alt="Generate Documentation" />
<img src="https://opengraph.githubassets.com/806cb063f690999b9217a714f2fa2abee929a6f29dda8c8969c921c99401d968/hoverkraft-tech/public-docs" width="60px" align="center" alt="Generate Documentation" />
</div>

---
Expand Down
2 changes: 1 addition & 1 deletion .github/actions/inject-docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# GitHub Action: Inject Documentation

<div align="center">
<img src="https://opengraph.githubassets.com/5c0e08a5a4b0e01ba74f3ea4fa1608246565f05e675b95f6347b793e8dccea51/hoverkraft-tech/public-docs" width="60px" align="center" alt="Inject Documentation" />
<img src="https://opengraph.githubassets.com/806cb063f690999b9217a714f2fa2abee929a6f29dda8c8969c921c99401d968/hoverkraft-tech/public-docs" width="60px" align="center" alt="Inject Documentation" />
</div>

---
Expand Down
2 changes: 1 addition & 1 deletion .github/actions/prepare-docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# GitHub Action: Prepare Documentation Bundle

<div align="center">
<img src="https://opengraph.githubassets.com/5c0e08a5a4b0e01ba74f3ea4fa1608246565f05e675b95f6347b793e8dccea51/hoverkraft-tech/public-docs" width="60px" align="center" alt="Prepare Documentation Bundle" />
<img src="https://opengraph.githubassets.com/806cb063f690999b9217a714f2fa2abee929a6f29dda8c8969c921c99401d968/hoverkraft-tech/public-docs" width="60px" align="center" alt="Prepare Documentation Bundle" />
</div>

---
Expand Down
6 changes: 3 additions & 3 deletions .github/actions/resolve-docs-target/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# GitHub Action: Resolve Documentation Target

<div align="center">
<img src="https://opengraph.githubassets.com/5c0e08a5a4b0e01ba74f3ea4fa1608246565f05e675b95f6347b793e8dccea51/hoverkraft-tech/public-docs" width="60px" align="center" alt="Resolve Documentation Target" />
<img src="https://opengraph.githubassets.com/806cb063f690999b9217a714f2fa2abee929a6f29dda8c8969c921c99401d968/hoverkraft-tech/public-docs" width="60px" align="center" alt="Resolve Documentation Target" />
</div>

---
Expand Down Expand Up @@ -42,7 +42,7 @@ Responsibilities:
# This input is required.
github-token: ""

# Repository slug in the form owner/repo.
# Repository slug in the form `owner/repo`.
# This input is required.
repository: ""
```
Expand All @@ -55,7 +55,7 @@ Responsibilities:
| **Input** | **Description** | **Required** | **Default** |
| ------------------ | ----------------------------------------------------- | ------------ | ----------- |
| **`github-token`** | GitHub token used to authenticate repository queries. | **true** | - |
| **`repository`** | Repository slug in the form owner/repository. | **true** | - |
| **`repository`** | Repository slug in the form `owner/repo`. | **true** | - |

<!-- inputs:end -->
<!-- secrets:start -->
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/sync-docs-dispatcher.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# GitHub Reusable Workflow: Push Documentation Helper

<div align="center">
<img src="https://opengraph.githubassets.com/5c0e08a5a4b0e01ba74f3ea4fa1608246565f05e675b95f6347b793e8dccea51/hoverkraft-tech/public-docs" width="60px" align="center" alt="Push Documentation Helper" />
<img src="https://opengraph.githubassets.com/806cb063f690999b9217a714f2fa2abee929a6f29dda8c8969c921c99401d968/hoverkraft-tech/public-docs" width="60px" align="center" alt="Push Documentation Helper" />
</div>

---
Expand Down
66 changes: 33 additions & 33 deletions application/docs/projects/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,23 +20,23 @@ export const projectSections = [

icon: '⚡',

title: 'ci-github-common',
title: 'compose-action',

titleHref: 'https://github.com/hoverkraft-tech/ci-github-common',
titleHref: 'https://github.com/hoverkraft-tech/compose-action',

meta: 'JavaScript • ⭐ 4 • Updated Apr 13, 2026',
meta: 'TypeScript • ⭐ 208 • Updated Apr 13, 2026',

description: 'Opinionated GitHub actions and workflows for common continuous integration needs',
description: 'This action runs your docker-compose file and clean up before action finished',

tags: [

'continuous-integration',

'github-actions',
'docker-compose',

'open-source',
'github-actions',

'workflow'
'open-source'

],

Expand All @@ -46,15 +46,15 @@ export const projectSections = [

label: 'View on GitHub',

href: 'https://github.com/hoverkraft-tech/ci-github-common'
href: 'https://github.com/hoverkraft-tech/compose-action'

},

{

label: 'Documentation',

href: 'https://docs.hoverkraft.cloud/docs/projects/github-actions-and-reusable-workflows/ci-github-common/'
href: 'https://docs.hoverkraft.cloud/docs/projects/github-actions-and-reusable-workflows/compose-action/'

}

Expand All @@ -66,25 +66,23 @@ export const projectSections = [

icon: '⚡',

title: 'ci-github-container',
title: 'ci-github-common',

titleHref: 'https://github.com/hoverkraft-tech/ci-github-container',
titleHref: 'https://github.com/hoverkraft-tech/ci-github-common',

meta: 'JavaScript • ⭐ 5 • Updated Apr 11, 2026',
meta: 'JavaScript • ⭐ 4 • Updated Apr 13, 2026',

description: 'Opinionated GitHub Actions and workflows for continuous integration in container (OCI) context',
description: 'Opinionated GitHub actions and workflows for common continuous integration needs',

tags: [

'build',

'containers',

'continuous-integration',

'docker',
'github-actions',

'github-actions'
'open-source',

'workflow'

],

Expand All @@ -94,15 +92,15 @@ export const projectSections = [

label: 'View on GitHub',

href: 'https://github.com/hoverkraft-tech/ci-github-container'
href: 'https://github.com/hoverkraft-tech/ci-github-common'

},

{

label: 'Documentation',

href: 'https://docs.hoverkraft.cloud/docs/projects/github-actions-and-reusable-workflows/ci-github-container/'
href: 'https://docs.hoverkraft.cloud/docs/projects/github-actions-and-reusable-workflows/ci-github-common/'

}

Expand All @@ -114,23 +112,25 @@ export const projectSections = [

icon: '⚡',

title: 'compose-action',
title: 'ci-github-container',

titleHref: 'https://github.com/hoverkraft-tech/compose-action',
titleHref: 'https://github.com/hoverkraft-tech/ci-github-container',

meta: 'TypeScript • ⭐ 207 • Updated Apr 10, 2026',
meta: 'JavaScript • ⭐ 5 • Updated Apr 11, 2026',

description: 'This action runs your docker-compose file and clean up before action finished',
description: 'Opinionated GitHub Actions and workflows for continuous integration in container (OCI) context',

tags: [

'continuous-integration',
'build',

'docker-compose',
'containers',

'github-actions',
'continuous-integration',

'open-source'
'docker',

'github-actions'

],

Expand All @@ -140,15 +140,15 @@ export const projectSections = [

label: 'View on GitHub',

href: 'https://github.com/hoverkraft-tech/compose-action'
href: 'https://github.com/hoverkraft-tech/ci-github-container'

},

{

label: 'Documentation',

href: 'https://docs.hoverkraft.cloud/docs/projects/github-actions-and-reusable-workflows/compose-action/'
href: 'https://docs.hoverkraft.cloud/docs/projects/github-actions-and-reusable-workflows/ci-github-container/'

}

Expand Down Expand Up @@ -1338,7 +1338,7 @@ export const statsSummary = {

activeProjects: 30,

totalStars: 260,
totalStars: 261,

programmingLanguages: 12,

Expand All @@ -1360,7 +1360,7 @@ export const projectSnapshot = {

lastUpdated: '2026-04-13',

technologiesSummary: 'including JavaScript, Astro, TypeScript, Makefile, HCL, and more.'
technologiesSummary: 'including TypeScript, JavaScript, Astro, Makefile, HCL, and more.'

};

Expand Down
2 changes: 1 addition & 1 deletion application/src/pages/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ function ProjectsSection() {
name: 'compose-action',
icon: '⚡',
url: 'https://github.com/hoverkraft-tech/compose-action',
stars: 207,
stars: 208,
language: 'TypeScript',
description: 'This action runs your docker-compose file and clean up before action finished',
tags: [
Expand Down