Skip to content

Commit c4ee70f

Browse files
committed
Added github package
1 parent 5ae5a05 commit c4ee70f

File tree

2 files changed

+12
-18
lines changed

2 files changed

+12
-18
lines changed

.github/workflows/release.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,3 @@ jobs:
5353
tags: |
5454
ghcr.io/${{ env.REPOSITORY_OWNER_LOWER }}/${{ github.event.repository.name }}:latest
5555
ghcr.io/${{ env.REPOSITORY_OWNER_LOWER }}/${{ github.event.repository.name }}:${{ env.VERSION_TAG }}
56-
57-
- name: Deploy (if needed)
58-
run: echo "Deploy step can be customized or automated here"

README.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -34,47 +34,44 @@ After these setup steps, the program will be ready for use.
3434

3535
## Docker
3636

37-
### Using Docker command
37+
### Using Docker Command
3838

3939
Before using Docker, ensure Docker is installed on your system. Visit [Docker's official installation guide](https://docs.docker.com/get-docker/) for help with the installation.
4040

41-
1. **Build the Docker Image**:
42-
From within the project directory (where the `Dockerfile` is located), build your Docker image:
41+
1. **Pull the Docker Image**:
42+
Pull the latest image of your project directly from GitHub Container Registry:
4343
```bash
44-
docker build -t go-shellcron .
44+
docker pull ghcr.io/jexsrs/go-shellcron:latest
4545
```
4646

4747
2. **Run your Docker Container**:
48-
You can run your Docker container with the following command:
48+
Run the Docker container using the image pulled from GHCR with the following command:
4949
```bash
50-
docker run --name go-shellcron -v $(pwd)/scripts:/scripts -d go-shellcron
50+
docker run --name go-shellcron -v $(pwd)/scripts:/scripts -d ghcr.io/jexsrs/go-shellcron:latest
5151
```
5252

5353
### Using Docker Compose
5454

5555
For an even simpler setup or deployment, you can utilize Docker Compose.
5656

5757
1. **Create a `docker-compose.yml` file**:
58-
Make sure you have a `docker-compose.yml` file in the root of your project with the following content:
58+
Make sure you have a `docker-compose.yml` file in the root of your project with the following content. Note that the `build` option is replaced by directly using the image from GHCR:
5959
```yaml
60+
version: '3.8'
6061
services:
6162
go-shellcron:
62-
container_name: go-shellcron
63+
image: ghcr.io/jexsrs/go-shellcron:latest
6364
restart: always
64-
image: go-shellcron
65-
build:
66-
context: ./
67-
dockerfile: Dockerfile
68-
env_file: ".env"
6965
volumes:
7066
- ./scripts:/scripts
7167
```
7268
7369
2. **Run using Docker Compose**:
74-
If you wish to run the services in the background (detached mode), use:
70+
To start your services using Docker Compose, run:
7571
```bash
76-
docker-compose up -d --build
72+
docker-compose up -d
7773
```
74+
7875

7976
## Script structure
8077
Here is a sample script to be processed by this scheduler:

0 commit comments

Comments
 (0)