diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index bb39dde..8b1e1d8 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -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' diff --git a/.github/workflows/dockerhub-description.yml b/.github/workflows/dockerhub-description.yml new file mode 100644 index 0000000..21f732b --- /dev/null +++ b/.github/workflows/dockerhub-description.yml @@ -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 }} \ No newline at end of file diff --git a/README.md b/README.md index 061a08f..958a911 100644 --- a/README.md +++ b/README.md @@ -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 -``` +Docker logo +Half-Life logo -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="" -``` \ No newline at end of file +This Docker image contains the dedicated server of the Half-Life game. \ No newline at end of file