From a63e7fa04bb977978421f6de135b5486b55e3d47 Mon Sep 17 00:00:00 2001 From: Simon Reinisch <simon@reinisch.io> Date: Thu, 2 Nov 2023 21:04:03 +0100 Subject: [PATCH] chore: update docker publish job --- .github/workflows/main.yml | 6 +++--- CONTRIBUTING.md | 6 +++--- README.md | 19 +++++++++---------- 3 files changed, 15 insertions(+), 16 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 422e8daa..86376138 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -64,14 +64,14 @@ jobs: with: images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} tags: | - ${{ github.ref_name }} - latest + type=semver,pattern=v{{version}} + type=semver,pattern=v{{major}}.{{minor}} - name: Build and push Docker image uses: docker/build-push-action@v5 with: - context: . push: true + provenance: false tags: ${{ steps.meta.outputs.tags }} labels: ${{ steps.meta.outputs.labels }} build-args: | diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d43dc911..916fb29f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,15 +1,15 @@ -### Commit guidelines +## Commit guidelines This project *strictly* follows [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). Check out [their explanation](https://www.conventionalcommits.org/en/v1.0.0/#summary) of how to use it. In this project we have the following scopes / types: -#### Scopes +### Scopes * `core` - Core code, anything app / user-facing related. * `setup` - Anything *only* relevant to the build-process / CI. -#### Types +### Types * `feat` - A new feature. * `refactor` - A refactoring. diff --git a/README.md b/README.md index 15ec1bc4..c47cee62 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ - ⚡️ Simple and straight-forward UI. > Check out the [demo](https://ocular.reinisch.io#demo)! +> Looking for the legacy google-app based version? Check out the [legacy](https://github.com/simonwep/ocular/tree/legacy) branch. ### Summary @@ -43,22 +44,20 @@ I consider the current state of it as the MVP for personal use. But I'm planning on adding more [features](https://github.com/Simonwep/ocular/issues) - I'm not planning of making it any more in-depth as it already is, planned features may only include adding a way to define goals or general improvements for mobile usage. As I already said, if you're looking for an in-depth tool to manage your finances check out [firefly](https://www.firefly-iii.org/)! -### Contributing - -If you want to work on this, make sure to out the [contributing guidelines](CONTRIBUTING.md) :) -Furthermore this project *does not* have releases. -Because of its simplicity the master branch is considered stable and any new feature will directly be merged into it. - -#### Development +### Development This app uses [genesis](https://github.com/simonwep/genesis) as generic backend. Go to the [genesis](https://github.com/simonwep/genesis) repository and follow the instructions to set it up first. -To run the frontend make sure you have the latest [NodeJS LTS](https://nodejs.org/en/) installed, as well as [pnpm](https://pnpm.io/). +To run the frontend make sure you have the latest [node LTS](https://nodejs.org/en/) installed, as well as [pnpm](https://pnpm.io/). You can then start the frontend by running `pnpm run dev` in the root directory. -#### Production +### Production This app is deployed using [docker-compose](https://docs.docker.com/compose/). -See [ocular-docker](https://github.com/simonwep/ocular-docker) for more information. +See [ocular-docker](https://github.com/simonwep/ocular-docker) for deployment. +### Contributing + +If you want to work on this, make sure to out the [contributing guidelines](CONTRIBUTING.md) :) +Other than that, follow the steps under [development](#development) to get started. \ No newline at end of file