Skip to content

Commit

Permalink
Feature/ci (#17)
Browse files Browse the repository at this point in the history
👷 CI enhancement (Strategy, PHP 8 and SonarCloud)
  • Loading branch information
llaumgui authored Dec 19, 2023
1 parent f85e154 commit 67baca5
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 17 deletions.
51 changes: 37 additions & 14 deletions .github/workflows/qa.yaml → .github/workflows/devops.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,30 @@ name: Tests
on:
[push, pull_request]

env:
phpLastVersion: '8.2'

jobs:

##############################################################################
# Tests job
#
tests:
test_php:
runs-on: ubuntu-latest
name: Test

strategy:
fail-fast: false
matrix:
php-version: ['8.1', '8.2', '8.3']
steps:
- uses: actions/checkout@v4

- name: Setup PHP with specific version of PECL extension
- name: Git checkout
uses: actions/checkout@v4
- name: Setup PHP ${{ matrix.php-version }} with PECL extension
uses: shivammathur/setup-php@v2
with:
php-version: '7.4'

php-version: ${{ matrix.php-version }}
- name: Validate composer.json and composer.lock
run: composer validate --strict

- name: Cache Composer packages
id: composer-cache
uses: actions/cache@v3
Expand All @@ -31,28 +35,47 @@ jobs:
key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
restore-keys: |
${{ runner.os }}-php-
- name: Install dependencies
run: composer install --prefer-dist --no-progress

- name: Run test suite
run: composer run-script test


##############################################################################
# Markdownlint job
#
test_markdownlint:
runs-on: ubuntu-latest
name: MarkdownLint

steps:

- name: Git checkout
uses: actions/checkout@v4

- name: markdownlint-cli
uses: nosborn/[email protected]
with:
files: "*.md"
config_file: ".markdownlint.yaml"

##############################################################################
# SonarCloud job
#
test_sonar:
needs: [
test_php,
test_markdownlint
]
runs-on: ubuntu-latest
name: SonarCloud analyse
steps:
- name: Git checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
- name: SonarCloud Scan
if: github.event_name != 'pull_request'
uses: sonarsource/sonarcloud-github-action@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
with:
args: >
-Dsonar.verbose=true
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# AuthFlarum

[![Author][ico-twitter]][link-twitter]
[![Software License][ico-license]](LICENSE)
[![Build Status][ico-ghactions]][link-ghactions]
[![MediaWiki Version][ico-mediawiki]][link-mediawiki]
[![Latest Version][ico-version]][link-packagist]

[![Software License][ico-license]](LICENSE)
[![Quality Gate Status][ico-sonarcloud-gate]][link-sonarcloud-gate]
[![Maintainability Rating][ico-sonarcloud-maintainability]][link-sonarcloud-maintainability]
[![Reliability Rating][ico-sonarcloud-reliability]][link-sonarcloud-reliability]
[![Security Rating][ico-sonarcloud-security]][link-sonarcloud-security]

Allows to connect to MediaWiki from an a ccount based on the [Flarum](https://flarum.org/) forum solution.

Expand Down Expand Up @@ -56,12 +60,20 @@ Example:
$wgAuthFlarumAutoCreateMinPost = 100;
```

[ico-twitter]: https://img.shields.io/static/v1?label=Author&message=llaumgui&color=50ABF1&logo=twitter&style=flat-square
[ico-twitter]: https://img.shields.io/static/v1?label=Author&message=llaumgui&color=000&logo=x&style=flat-square
[link-twitter]: https://twitter.com/llaumgui
[ico-mediawiki]: https://img.shields.io/static/v1?label=mediawiki&message=%E2%89%A51.36&color=cd1f44&logo=wikipedia&style=flat-square
[link-mediawiki]: https://www.mediawiki.org/
[ico-ghactions]: https://img.shields.io/github/actions/workflow/status/llaumgui/mw-auth-flarum/qa.yaml?branch=main&style=flat-square&logo=github&label=Tests
[ico-ghactions]: https://img.shields.io/github/actions/workflow/status/llaumgui/mw-auth-flarum/devops.yaml?branch=main&style=flat-square&logo=github&label=Tests
[link-ghactions]: https://github.com/llaumgui/mw-auth-flarum/actions
[ico-version]: https://img.shields.io/packagist/v/llaumgui/mw-auth-flarum.svg?include_prereleases&label=Package%20version&style=flat-square&logo=packagist
[link-packagist]: https://packagist.org/packages/llaumgui/mw-auth-flarum
[ico-license]: https://img.shields.io/github/license/llaumgui/mw-auth-flarum?style=flat-square
[ico-sonarcloud-gate]: https://sonarcloud.io/api/project_badges/measure?branch=main&project=llaumgui_mw-auth-flarum&metric=alert_status
[link-sonarcloud-gate]: https://sonarcloud.io/dashboard?id=llaumgui_mw-auth-flarum&branch=main
[ico-sonarcloud-maintainability]: https://sonarcloud.io/api/project_badges/measure?project=llaumgui_mw-auth-flarum&metric=sqale_rating
[link-sonarcloud-maintainability]: https://sonarcloud.io/dashboard?id=llaumgui_mw-auth-flarum
[ico-sonarcloud-reliability]: https://sonarcloud.io/api/project_badges/measure?project=llaumgui_mw-auth-flarum&metric=reliability_rating
[link-sonarcloud-reliability]: https://sonarcloud.io/dashboard?id=llaumgui_mw-auth-flarum
[ico-sonarcloud-security]: https://sonarcloud.io/api/project_badges/measure?project=llaumgui_mw-auth-flarum&metric=security_rating
[link-sonarcloud-security]: https://sonarcloud.io/dashboard?id=llaumgui_mw-auth-flarum
14 changes: 14 additions & 0 deletions sonar-project.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Project informations
sonar.organization=llaumgui
sonar.projectKey=llaumgui_mw-auth-flarum
sonar.projectName=mw-auth-flarum
sonar.version=1.0.0

# Project URLs
sonar.links.homepage=https://github.com/llaumgui/mw-auth-flarum
sonar.links.ci=https://github.com/llaumgui/mw-auth-flarum/actions
sonar.links.scm=https://github.com/llaumgui/mw-auth-flarum
sonar.links.issue=https://github.com/llaumgui/mw-auth-flarum/issues

# Properties that will be shared amongst all modules
sonar.sources=src

0 comments on commit 67baca5

Please sign in to comment.