Skip to content

Commit d206c78

Browse files
Daschi1Daschi1
authoredAug 12, 2024
Merge pull request #10 from Daschi1/development-daschi
Development daschi
2 parents 44a040b + 2ff08d5 commit d206c78

File tree

5 files changed

+124
-121
lines changed

5 files changed

+124
-121
lines changed
 

‎.github/workflows/build-and-publish-docker.yml

+40-67
Original file line numberDiff line numberDiff line change
@@ -1,98 +1,71 @@
11
name: Build and Publish Docker Image
22

3-
# This workflow triggers on a push to the main branch or pull requests targeting the main branch.
43
on:
54
push:
6-
branches: [ "main" ] # Trigger on push to the main branch
5+
branches: [ "main" ] # Trigger the workflow when code is pushed to the main branch
76
pull_request:
8-
branches: [ "main" ] # Trigger on pull requests to the main branch
7+
branches: [ "main" ] # Trigger the workflow for pull requests targeting the main branch
98

109
env:
11-
# Docker registry configuration
12-
REGISTRY: ghcr.io # Use GitHub Container Registry by default
13-
IMAGE_NAME: ${{ github.repository }} # Docker image name is the GitHub repository name
10+
REGISTRY: ghcr.io # Set the Docker registry to GitHub Container Registry (ghcr.io)
11+
IMAGE_NAME: ${{ github.repository }} # Use the GitHub repository name as the Docker image name
1412

1513
jobs:
1614
build-and-publish:
17-
18-
runs-on: ubuntu-latest # Use the latest Ubuntu runner for this job
15+
runs-on: ubuntu-latest # Use the latest stable Ubuntu version as the runner environment
1916
permissions:
20-
contents: read # Allows the workflow to read repository contents
21-
packages: write # Allows the workflow to write to GitHub Packages (e.g., Docker images)
22-
id-token: write # Required for signing Docker images with cosign outside of PRs
17+
contents: read # Allows reading of repository contents
18+
packages: write # Allows publishing packages (e.g., Docker images) to GitHub Packages
19+
id-token: write # Required for future features like signing images with cosign
2320

2421
steps:
2522
# Step 1: Check out the repository code
2623
- name: Checkout repository
27-
uses: actions/checkout@v4
28-
# This step checks out the repository code so the workflow can access it
24+
uses: actions/checkout@v4 # This action checks out the repository code for use in the workflow
2925

3026
# Step 2: Extract version information from package.json
3127
- name: Extract version from package.json
32-
id: version
28+
id: version # Assign an ID to reference this step's outputs later if needed
3329
run: |
34-
# Extract the full version (e.g., 1.2.3) from package.json
35-
MAJOR_MINOR_PATCH=$(grep '"version":' package.json | cut -d '"' -f 4)
36-
# Extract the major.minor version (e.g., 1.2)
37-
MAJOR_MINOR=$(echo $MAJOR_MINOR_PATCH | cut -d '.' -f1-2)
38-
# Extract the major version (e.g., 1)
39-
MAJOR=$(echo $MAJOR_MINOR_PATCH | cut -d '.' -f1)
40-
# Store the extracted values as environment variables for use in later steps
41-
echo "MAJOR_MINOR_PATCH=$MAJOR_MINOR_PATCH" >> $GITHUB_ENV
42-
echo "MAJOR_MINOR=$MAJOR_MINOR" >> $GITHUB_ENV
43-
echo "MAJOR=$MAJOR" >> $GITHUB_ENV
44-
45-
# Step 3: Install the cosign tool for signing Docker images
46-
- name: Install cosign
47-
if: github.event_name != 'pull_request' # Only install cosign if not a PR
48-
uses: sigstore/cosign-installer@v3
49-
# This installs the cosign tool for use in the signing step later
30+
# Extract the semantic version (e.g., 1.2.3) from the package.json file
31+
SEMVER=$(grep '"version":' package.json | cut -d '"' -f 4)
32+
# Store the extracted version as an environment variable for use in later steps
33+
echo "SEMVER=$SEMVER" >> $GITHUB_ENV
5034
51-
# Step 4: Set up Docker Buildx for building multi-platform Docker images
35+
# Step 3: Set up Docker Buildx
5236
- name: Set up Docker Buildx
53-
uses: docker/setup-buildx-action@v3
54-
# Docker Buildx enables advanced features like multi-platform builds and cache exporting
37+
uses: docker/setup-buildx-action@v3 # Set up Docker Buildx to enable advanced Docker features
38+
# Docker Buildx allows for multi-platform builds, build caching, and more
5539

56-
# Step 5: Log in to the Docker registry
40+
# Step 4: Log in to the Docker registry
5741
- name: Log into registry ${{ env.REGISTRY }}
58-
uses: docker/login-action@v3
42+
uses: docker/login-action@v3 # Log into the Docker registry to enable pushing images
5943
with:
60-
registry: ${{ env.REGISTRY }} # The Docker registry to log into
61-
username: ${{ github.actor }} # Use the GitHub actor (user) as the username
62-
password: ${{ secrets.GITHUB_TOKEN }} # Use the GitHub token as the password
63-
# This step logs in to the Docker registry so that images can be pushed
44+
registry: ${{ env.REGISTRY }} # Specify the Docker registry (ghcr.io)
45+
username: ${{ github.actor }} # Use the GitHub actor (the user triggering the workflow) as the username
46+
password: ${{ secrets.GITHUB_TOKEN }} # Use the GitHub token to authenticate (securely passed as a secret)
6447

65-
# Step 6: Extract Docker image metadata (tags, labels)
48+
# Step 5: Extract Docker image metadata (tags, labels)
6649
- name: Extract Docker metadata
67-
id: meta # Assigns an ID to this step for referencing its outputs later
68-
uses: docker/metadata-action@v5
50+
id: meta # Assign an ID to reference this step's outputs (tags and labels) in the build step
51+
uses: docker/metadata-action@v5 # This action generates Docker image metadata like tags and labels
6952
with:
70-
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
53+
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} # Define the full image name (registry/repository)
7154
tags: |
72-
# Define tags for the Docker image using version information
73-
${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
74-
${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ env.MAJOR_MINOR_PATCH }}
75-
${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ env.MAJOR_MINOR }}
76-
${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ env.MAJOR }}
55+
# Create various tags for the Docker image based on version information
56+
type=raw,value=latest # Tag the image as "latest"
57+
type=semver,pattern={{major}}.{{minor}}.{{patch}},value=${{ env.SEMVER }} # Full version tag (e.g., 1.2.3)
58+
type=semver,pattern={{major}}.{{minor}},value=${{ env.SEMVER }} # Major.minor tag (e.g., 1.2)
59+
type=semver,pattern={{major}},value=${{ env.SEMVER }} # Major tag (e.g., 1)
7760
78-
# Step 7: Build and push Docker image using Docker Buildx
61+
# Step 6: Build and push the Docker image
7962
- name: Build and push Docker image
80-
id: build-and-push # Assigns an ID to this step for referencing its outputs later
81-
uses: docker/build-push-action@v5
63+
id: build-and-push # Assign an ID to reference this step's outputs (digest) if needed later
64+
uses: docker/build-push-action@v5 # This action builds and pushes the Docker image
8265
with:
83-
context: . # The context is the root of the repository
84-
push: ${{ github.event_name != 'pull_request' }} # Only push if not a PR
85-
tags: ${{ steps.meta.outputs.tags }} # Use the tags generated in the previous step
86-
labels: ${{ steps.meta.outputs.labels }} # Use the labels generated in the previous step
87-
cache-from: type=gha # Use GitHub Actions cache to speed up builds
88-
cache-to: type=gha,mode=max # Store the cache in GitHub Actions for reuse
89-
# This step builds the Docker image and pushes it to the registry (if not a PR)
90-
91-
# Step 8: Sign the resulting Docker image digest (only if not a PR)
92-
- name: Sign the published Docker image
93-
if: ${{ github.event_name != 'pull_request' }} # Only sign if not a PR
94-
env:
95-
TAGS: ${{ steps.meta.outputs.tags }} # Use the tags generated earlier
96-
DIGEST: ${{ steps.build-and-push.outputs.digest }} # Use the digest of the built image
97-
run: echo "${TAGS}" | xargs -I {} cosign sign --yes {}@${DIGEST}
98-
# This step signs the Docker image using cosign to ensure its integrity and authenticity
66+
context: . # Use the root of the repository as the build context (includes Dockerfile and source code)
67+
push: ${{ github.event_name != 'pull_request' }} # Push the image only if the event is not a pull request
68+
tags: ${{ steps.meta.outputs.tags }} # Apply the tags generated in the metadata step
69+
labels: ${{ steps.meta.outputs.labels }} # Apply the labels generated in the metadata step
70+
cache-from: type=gha # Use GitHub Actions cache to speed up the build process
71+
cache-to: type=gha,mode=max # Store the build cache in GitHub Actions for future use

‎README.md

+12
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,15 @@ generate `licenses.json`.
2727
```shell
2828
license-checker --customPath lc-checker-format.json --json --out static/licenses.json
2929
```
30+
31+
### Currently deployed version
32+
33+
```shell
34+
docker run -d \
35+
--name green-hell-maps \
36+
--restart unless-stopped \
37+
-e ORIGIN=https://green-hell-maps.daschi.dev \
38+
ghcr.io/daschi1/green-hell-maps:1.0.0
39+
40+
docker network connect nginx green-hell-maps
41+
```

‎package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
"@sveltejs/vite-plugin-svelte": "^3.1.1",
2222
"@types/eslint": "^9.6.0",
2323
"autoprefixer": "^10.4.20",
24+
"dotenv": "^16.4.5",
2425
"eslint": "^9.9.0",
2526
"eslint-config-prettier": "^9.1.0",
2627
"eslint-plugin-svelte": "^2.43.0",
@@ -34,7 +35,7 @@
3435
"prettier": "^3.3.3",
3536
"prettier-plugin-svelte": "^3.2.6",
3637
"prettier-plugin-tailwindcss": "^0.6.6",
37-
"svelte": "^5.0.0-next.216",
38+
"svelte": "^5.0.0-next.217",
3839
"svelte-check": "^3.8.5",
3940
"sveltekit-search-params": "^3.0.0",
4041
"tailwindcss": "^3.4.9",

0 commit comments

Comments
 (0)