Use forgejo registry for the image
All checks were successful
Test, Build and Publish / test (push) Successful in 34s
Test, Build and Publish / build-and-push-images (push) Successful in 1m10s

This commit is contained in:
Marc Di Luzio 2024-08-25 21:16:25 +01:00
parent 25cb5b9dba
commit 7afa5086fd
3 changed files with 8 additions and 19 deletions

View file

@ -10,10 +10,7 @@ on:
workflow_dispatch: workflow_dispatch:
env: env:
# Use the github container registry REGISTRY: forge.mdiluz.io
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}
jobs: jobs:
@ -42,12 +39,6 @@ jobs:
runs-on: ubuntu-22.04 runs-on: ubuntu-22.04
needs: test needs: test
permissions:
contents: read
packages: write
attestations: write
id-token: write
steps: steps:
- name: Checkout repository - name: Checkout repository
uses: actions/checkout@v4 uses: actions/checkout@v4
@ -56,8 +47,8 @@ jobs:
uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1 uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
with: with:
registry: ${{ env.REGISTRY }} registry: ${{ env.REGISTRY }}
username: ${{ github.actor }} username: ${{ env.GITHUB_ACTOR }}
password: ${{ secrets.GH_PAT }} password: ${{ secrets.PACKAGE_PAT }}
- name: Set up Docker Buildx - name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3 uses: docker/setup-buildx-action@v3
@ -66,7 +57,7 @@ jobs:
id: meta id: meta
uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7 uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
with: with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} images: ${{ env.REGISTRY }}/${{ env.GITHUB_REPOSITORY }}
tags: | tags: |
type=ref,event=tag type=ref,event=tag
type=ref,event=branch type=ref,event=branch

View file

@ -7,8 +7,6 @@ Matchy is a Discord bot that groups up users for fun and vibes. Matchy can be in
Note: Matchy currently only allows owner-authorised users to trigger posts in channels. Note: Matchy currently only allows owner-authorised users to trigger posts in channels.
![Tests](https://github.com/mdiluz/matchy/actions/workflows/test.yml/badge.svg)
## Commands ## Commands
Matchy supports a bunch of user, `matcher` and bot owner commands. `/` commands are available in any channel the bot has access to, and `$` commands are only available in DMs. Matchy supports a bunch of user, `matcher` and bot owner commands. `/` commands are available in any channel the bot has access to, and `$` commands are only available in DMs.
@ -35,7 +33,7 @@ Development has been on on Linux so far, but running on Mac or Windows _should_
### Getting Started ### Getting Started
```bash ```bash
git clone git@github.com:mdiluz/matchy.git git clone https://forge.mdiluz.io/mdiluz/matchy.git
cd matchy cd matchy
python -m venv .venv python -m venv .venv
source .venv/bin/activate source .venv/bin/activate
@ -56,11 +54,11 @@ State is stored locally in a `.matchy/state.json` file. This will be created by
The `TOKEN` envar is required run the bot. It's recommended this is placed in a local `.env` file. To generate bot token for development see [this discord.py guide](https://discordpy.readthedocs.io/en/stable/discord.html). The `TOKEN` envar is required run the bot. It's recommended this is placed in a local `.env` file. To generate bot token for development see [this discord.py guide](https://discordpy.readthedocs.io/en/stable/discord.html).
### Docker ### Docker
Docker and Compose configs are provided, with the latest release tagged as `ghcr.io/mdiluz/matchy:latest`. A location for persistent data is stil required so some persistent volume will need to be mapped into the container as `/usr/share/app/.matchy`. Docker and Compose configs are provided, with the latest release tagged as `forge.mdiluz.io/mdiluz/matchy:latest`. A location for persistent data is stil required so some persistent volume will need to be mapped into the container as `/usr/share/app/.matchy`.
An example for how to do this may look like this: An example for how to do this may look like this:
```bash ```bash
docker run -v --env-file=.env ./.matchy:/usr/src/app/.matchy ghcr.io/mdiluz/matchy:latest docker run -v --env-file=.env ./.matchy:/usr/src/app/.matchy forge.mdiluz.io/mdiluz/matchy:latest
``` ```
A [`docker-compose.yml`](docker-compose.yml) file is also provided that essentially performs the above when used with `docker compose up --exit-code-from matchy`. A `MATCHY_DATA` envar can be used in conjunction with compose to set a custom local path for the location of the data file. A [`docker-compose.yml`](docker-compose.yml) file is also provided that essentially performs the above when used with `docker compose up --exit-code-from matchy`. A `MATCHY_DATA` envar can be used in conjunction with compose to set a custom local path for the location of the data file.

View file

@ -1,6 +1,6 @@
services: services:
matchy: matchy:
image: ghcr.io/mdiluz/matchy:${MATCHY_TAG:-latest} image: forge.mdiluz.io/mdiluz/matchy:${MATCHY_TAG:-latest}
env_file: ".env" env_file: ".env"
volumes: volumes:
- ${MATCHY_DATA:-./.matchy}:/usr/src/app/.matchy - ${MATCHY_DATA:-./.matchy}:/usr/src/app/.matchy