Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Auto update docker hub description via GH workflow
  • Loading branch information
dormant-user committed Sep 11, 2024
1 parent 2fd57c2 commit f8b3c02
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 3 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/description.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Update Docker Hub Description
on:
push:
branches:
- main
paths:
- README.md
- .github/workflows/description.yml

jobs:
dockerHubDescription:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Docker Hub Description
uses: peter-evans/dockerhub-description@v4
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: peterevans/dockerhub-description
# Spin up an on-demand self-hosted GitHub action runner with multi-arch supported Ubuntu image
short-description: ${{ github.event.repository.description }}
enable-url-completion: false
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# GitHub Runner Linux

[![Test Runner][badges-test]][links-test]
<br>
[![Build and Publish][badges-build]][links-build]

Spin up an on-demand self-hosted GitHub action runner with multi-arch supported Ubuntu image.
Expand Down Expand Up @@ -31,6 +32,7 @@ docker compose up -d
- **REUSE_EXISTING** - Re-use existing configuration. Defaults to `false`

> [!NOTE]
>
> `REUSE_EXISTING` flag can be useful when a container restarts due to an issue or
> when a container is reused after being terminated without shutting down gracefully.
> <details>
Expand All @@ -55,9 +57,10 @@ docker compose up -d
> ```
> </details>
> [!WARNING]
Using this image **without** the env var `GIT_REPOSITORY` will create an organization level runner.
Using self-hosted runners in public repositories pose some considerable security threats.
> [!WARNING]
>
> Using this image **without** the env var `GIT_REPOSITORY` will create an organization level runner.<br>
> Using self-hosted runners in public repositories pose some considerable security threats.
> - [#self-hosted-runner-security]
> - [#restricting-the-use-of-self-hosted-runners]
> - [#configuring-required-approval-for-workflows-from-public-forks]
Expand Down

0 comments on commit f8b3c02

Please sign in to comment.