Skip to content

Commit

Permalink
Update CI & README
Browse files Browse the repository at this point in the history
  • Loading branch information
SergeyShorokhov committed Mar 31, 2024
1 parent 81400d5 commit a047f62
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 26 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ name: Docker Image CI
on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
paths-ignore:
- "**.md"
workflow_dispatch:
schedule:
- cron: '0 0 * * 0'
Expand Down
27 changes: 27 additions & 0 deletions .github/workflows/dockerhub-description.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Update Docker Hub Description

on:
workflow_dispatch:
push:
branches: [ master ]
paths:
- README.md
- .github/workflows/dockerhub-description.yml

env:
DOCKER_IMAGE: ${{ secrets.DOCKER_USERNAME }}/hlds

jobs:

update_description:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4.1.1

- name: Docker Hub Description
uses: peter-evans/dockerhub-description@v4
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: ${{ env.DOCKER_IMAGE }}
short-description: ${{ github.event.repository.description }}
31 changes: 7 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,9 @@
Usage:
```bash
docker build -t hlds-gameserver .
```
[![Docker Pulls](https://img.shields.io/docker/pulls/wopox1337/hlds?logo=docker&logoColor=blue)](https://hub.docker.com/r/wopox1337/hlds)
[![Docker Image Size](https://img.shields.io/docker/image-size/wopox1337/hlds?logo=docker&logoColor=blue)](https://hub.docker.com/r/wopox1337/hlds)
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/hlds-docker/hlds/CI.yml?logo=github&logoColor=white)](https://github.com/hlds-docker/hlds/actions/workflows/CI.yml)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/110aad918e184a51956adf55f6e770b3)](https://app.codacy.com/gh/hlds-docker/hlds/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)

```bash
docker run -it --rm --name MyGreatHLDS \
-p 27016:27016/udp \
-e SERVER_NAME="MyServer :)" \
hlds-gameserver
```
<img src="https://raw.githubusercontent.com/docker-library/docs/c350af05d3fac7b5c3f6327ac82fe4d990d8729c/docker/logo.png" alt="Docker logo" width=200px>
<img src="https://camo.githubusercontent.com/09985a1c32a1b82696b28766ab6f05d0d28df0139b5d9ee2a88c740c3d9cc21b/68747470733a2f2f7669676e657474652e77696b69612e6e6f636f6f6b69652e6e65742f68616c662d6c6966652f696d616765732f642f64632f4c616d6264615f6c6f676f2e7376672f7265766973696f6e2f6c61746573742f7363616c652d746f2d77696474682d646f776e2f3235303f63623d323031303033323731373435343626706174682d7072656669783d656e" alt="Half-Life logo" width=200>

Usage with compose file:
```bash
docker-compose up
```

## Environment
```bash
PORT="27016"
MAXPLAYERS="10"
MAP="crossfire"
SERVER_NAME="My HalfLife Server!"
SV_LAN="0"
RCON_PASSWORD=""
```
This Docker image contains the dedicated server of the Half-Life game.

0 comments on commit a047f62

Please sign in to comment.