Skip to content
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.

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

docs: Correct (and test) documented examples #27

Merged
merged 8 commits into from
Nov 28, 2023
Merged
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
3 changes: 3 additions & 0 deletions .github/tests/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 63 additions & 0 deletions .github/workflows/test-readme.yaml
Original file line number Diff line number Diff line change
@@ -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
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
Loading