From 21c07dac746b041f04827dd2ba6fbd13842dd3f8 Mon Sep 17 00:00:00 2001 From: dkoeni <116151702+dkoeni@users.noreply.github.com> Date: Fri, 5 Jul 2024 15:41:36 +0200 Subject: [PATCH] update readme (#31) * add badges * add trigger for workflow on push to main branch --- .github/workflows/lint-openapi.yaml | 3 +++ .github/workflows/lint-yaml.yaml | 3 +++ README.md | 11 ++++++----- 3 files changed, 12 insertions(+), 5 deletions(-) diff --git a/.github/workflows/lint-openapi.yaml b/.github/workflows/lint-openapi.yaml index ddccd01..d21e4a2 100644 --- a/.github/workflows/lint-openapi.yaml +++ b/.github/workflows/lint-openapi.yaml @@ -2,6 +2,9 @@ name: 'SFTI Lint Specifications: OpenAPI Compliance' on: pull_request: + push: + branches: + - main workflow_dispatch: inputs: filenames: diff --git a/.github/workflows/lint-yaml.yaml b/.github/workflows/lint-yaml.yaml index ae3026a..82a78ce 100644 --- a/.github/workflows/lint-yaml.yaml +++ b/.github/workflows/lint-yaml.yaml @@ -2,6 +2,9 @@ name: 'SFTI Lint Specifications: Yaml Compliance' on: pull_request: + push: + branches: + - main workflow_dispatch: inputs: filenames: diff --git a/README.md b/README.md index 76e9a43..88aa702 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,14 @@ --- -[![GitHub release](https://img.shields.io/github/release/swissfintechinnovations/ca-pension)](https://github.com/swissfintechinnovations/ca-pension/releases/) -[![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/swissfintechinnovations/ca-pension/lint-yaml.yaml?label=Lint%20checks)](https://github.com/swissfintechinnovations/ca-pension/actions) -[![Swagger Validator](https://img.shields.io/swagger/valid/3.0?specUrl=https://raw.githubusercontent.com/swissfintechinnovations/ca-pension/main/consentAPI.yaml)](https://github.com/swissfintechinnovations/ca-pension/wiki/Swagger-Editor) -[![GitHub license](https://img.shields.io/github/license/swissfintechinnovations/ca-pension)](https://github.com/swissfintechinnovations/ca-pension/blob/main/LICENSE) +[![GitHub release](https://img.shields.io/github/release/swissfintechinnovations/ca-pension?color=blue)](https://github.com/swissfintechinnovations/ca-pension/releases/) +[![GitHub Action Status OpenAPI](https://img.shields.io/github/actions/workflow/status/swissfintechinnovations/ca-pension/lint-openapi.yaml?branch=main&label=openapi%20checks)](https://github.com/swissfintechinnovations/ca-pension/actions/workflows/lint-openapi.yaml) +[![GitHub Action Status Yaml](https://img.shields.io/github/actions/workflow/status/swissfintechinnovations/ca-pension/lint-yaml.yaml?branch=main&label=yaml%20checks)](https://github.com/swissfintechinnovations/ca-pension/actions/workflows/lint-yaml.yaml) +[![OpenAPI version](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fgithub.com%2Fswissfintechinnovations%2Fca-pension%2Fraw%2Fmain%2FpensionAPI.yaml&query=openapi&prefix=v&label=OpenAPI&color=blue)](https://swagger.io/resources/open-api/) +[![GitHub license](https://img.shields.io/github/license/swissfintechinnovations/ca-pension?color=de980d)](https://github.com/swissfintechinnovations/ca-pension/blob/main/LICENSE) This is the official SFTI repo for the pension API. Documentations may be found in the [Wiki](https://github.com/swissfintechinnovations/ca-pension/wiki). We refer to the [offical government website](https://www.kmu.admin.ch/kmu/de/home/praktisches-wissen/personal/personalmanagement/pflichten-der-arbeitgebenden/sozialversicherungen/pensionskasse-bvg.html) for more information. - +