docs: Correct (and test) documented examples (#27)

This commit is contained in:
sam 2023-11-29 01:03:52 +07:00 committed by GitHub
parent e8af259fb1
commit 15c8bf3149
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 77 additions and 11 deletions

View file

@ -9,3 +9,6 @@ RUN echo "Hello, World 3! \$(date)" > /files/003.txt
RUN echo "Hello, World 4! \$(date)" > /files/x/004.txt
RUN echo "Hello, World 5! \$(date)" > /files/x/005.txt
RUN echo "Hello, World 6! \$(date)" > /files/y/006.txt
RUN mkdir -p /app/
RUN echo "<h1>Hello, World!</h1>" > /app/index.html

63
.github/workflows/test-readme.yaml vendored Normal file
View file

@ -0,0 +1,63 @@
name: Test Readme Example
on: [workflow_dispatch]
jobs:
build-extract:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Build Docker Image
uses: docker/build-push-action@v5
with:
context: ./.github/tests
tags: my-example-image:latest
load: true
- uses: shrink/actions-docker-extract@v3
id: extract
with:
image: my-example-image:latest
path: /app/.
destination: dist
- name: Upload Dist
uses: actions/upload-artifact@v3
with:
path: dist
example-image:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Login to GitHub Container Registry
uses: docker/login-action@v3
with:
registry: "ghcr.io"
username: "${{ github.actor }}"
password: "${{ secrets.GITHUB_TOKEN }}"
- name: Build Docker Image
uses: docker/build-push-action@v5
with:
context: ./.github/tests
push: true
tags: ghcr.io/${{ github.repository }}:latest
login-pull-extract:
runs-on: ubuntu-latest
needs:
- example-image
steps:
- uses: actions/checkout@v4
- name: Login to GitHub Container Registry
uses: docker/login-action@v2
with:
registry: "ghcr.io"
username: "${{ github.actor }}"
password: "${{ secrets.GITHUB_TOKEN }}"
- uses: shrink/actions-docker-extract@v3
id: extract
with:
image: ghcr.io/${{ github.repository }}:latest
path: /app/.
destination: dist
- name: Upload Dist
uses: actions/upload-artifact@v3
with:
path: dist

View file

@ -44,18 +44,18 @@ jobs:
- name: Build Docker Image
uses: docker/build-push-action@v5
with:
repository: my-example-image
tags: latest
tags: my-example-image:latest
load: true
- uses: shrink/actions-docker-extract@v3
id: extract
with:
image: my-example-image
image: my-example-image:latest
path: /app/.
destination: dist
- name: Upload Dist
uses: actions/upload-artifact@v3
with:
path: ${{ steps.extract.outputs.destination }}
name: dist
path: dist
```
### Login, Pull, Extract
@ -70,21 +70,21 @@ jobs:
steps:
- uses: actions/checkout@v4
- name: Login to GitHub Container Registry
uses: docker/login-action@v1
uses: docker/login-action@v2
with:
registry: ghcr.io
username: ${{ github.repository_owner }}
password: ${{ secrets.GHCR_PAT }}
registry: "ghcr.io"
username: "${{ github.actor }}"
password: "${{ secrets.GITHUB_TOKEN }}"
- uses: shrink/actions-docker-extract@v3
id: extract
with:
image: ghcr.io/${{ github.repository }}:latest
path: /app/.
destination: dist
- name: Upload Dist
uses: actions/upload-artifact@v3
with:
path: ${{ steps.extract.outputs.destination }}
name: dist
path: dist
```
## Automatic Release Packaging