Skip to content

Commit 3bd2bf3

Browse files
authored
Harmonize CI & files (#49)
1 parent df75175 commit 3bd2bf3

File tree

10 files changed

+57
-41
lines changed

10 files changed

+57
-41
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @yoanm

.github/workflows/coverage-upload.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ permissions:
99
checks: write # For the check run creation !
1010

1111
jobs:
12-
upload:
12+
coverage:
1313
name: Coverage
1414
permissions:
1515
contents: read

.github/workflows/pre-check-CI-updates.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jobs:
3030
contents: read
3131
uses: ./.github/workflows/reusable-CI-workflow.yml
3232

33-
upload:
33+
coverage:
3434
name: Coverage
3535
needs: [tests]
3636
permissions:

.remarkrc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
{
22
"plugins": [
33
"remark-preset-lint-consistent",
4-
"remark-preset-lint-recommended"
4+
"remark-preset-lint-recommended",
5+
[
6+
"remark-lint-list-item-indent",
7+
"space"
8+
]
59
]
610
}

.scrutinizer.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ build:
4141
variables:
4242
CI: 'true'
4343
TEST_OUTPUT_STYLE: 'pretty'
44-
COMPOSER_OPTIONS: '--optimize-autoloader'
4544
COVERAGE_OUTPUT_STYLE: 'clover'
4645
COVERAGE_CLOVER_FILE_PATH: 'build/coverage/clover.xml'
4746
PHPCS_DISABLE_WARNING: 'true'

CODE_OF_CONDUCT.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ include:
2323
Examples of unacceptable behavior by participants include:
2424

2525
* The use of sexualized language or imagery and unwelcome sexual attention or
26-
advances
26+
advances
2727
* Trolling, insulting/derogatory comments, and personal or political attacks
2828
* Public or private harassment
2929
* Publishing others' private information, such as a physical or electronic
30-
address, without explicit permission
30+
address, without explicit permission
3131
* Other conduct which could reasonably be considered inappropriate in a
32-
professional setting
32+
professional setting
3333

3434
## Our Responsibilities
3535

CONTRIBUTING.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,39 @@
11
# Contributing
22

33
## Getting Started
4-
* Fork, then clone the repo:
4+
5+
* Fork, then clone the repo:
6+
57
```bash
68
git clone git@github.com:your-username/php-jsonrpc-http-server-swagger-doc-sdk.git
7-
````
9+
```
10+
11+
* Make sure everything goes well:
812

9-
* Make sure everything goes well:
1013
```bash
1114
make build
1215
make test
1316
```
1417

15-
* Make your changes (Add/Update tests according to your changes).
16-
* Make sure tests are still green:
18+
* Make your changes (Add/Update tests according to your changes).
19+
* Make sure tests are still green:
20+
1721
```bash
1822
make test
1923
```
2024

21-
* To check code coverage, launch
25+
* To check code coverage, launch
26+
2227
```bash
2328
make coverage
2429
```
2530

26-
* Push to your fork and [submit a pull request](https://github.com/yoanm/php-jsonrpc-http-server-swagger-doc-sdk/compare/).
27-
* Wait for feedback or merge.
31+
* Push to your fork and [submit a pull request](https://github.com/yoanm/php-jsonrpc-http-server-swagger-doc-sdk/compare/).
32+
* Wait for feedback or merge.
33+
34+
Some stuff that will increase your pull request's acceptance:
2835

29-
Some stuff that will increase your pull request's acceptance:
30-
* Write tests.
31-
* Follow PSR-2 coding style.
32-
* Write good commit messages.
33-
* Do not rebase or squash your commits when a review has been made.
36+
* Write tests.
37+
* Follow PSR-2 coding style.
38+
* Write good commit messages.
39+
* Do not rebase or squash your commits when a review has been made.

Makefile

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,5 +109,13 @@ scrutinizer-behat:
109109
create-build-directories:
110110
mkdir -p ${PHPUNIT_COVERAGE_DIRECTORY} ${BEHAT_COVERAGE_DIRECTORY} ${REPORTS_DIRECTORY}
111111

112+
.PHONY: configure-dev-env
113+
configure-dev-env:
114+
npm install --global remark-cli remark-preset-lint-consistent remark-preset-lint-recommended remark-lint-list-item-indent
115+
116+
.PHONY: lint-markdown
117+
lint-markdown:
118+
npx remark . --output
119+
112120
.PHONY: build install configure test test-unit test-functional codestyle create-build-directories scrutinizer-behat scrutinizer-phpunit
113121
.DEFAULT: build

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
[![License](https://img.shields.io/github/license/yoanm/php-jsonrpc-http-server-swagger-doc-sdk.svg)](https://github.com/yoanm/php-jsonrpc-http-server-swagger-doc-sdk)
44
[![Code size](https://img.shields.io/github/languages/code-size/yoanm/php-jsonrpc-http-server-swagger-doc-sdk.svg)](https://github.com/yoanm/php-jsonrpc-http-server-swagger-doc-sdk)
5-
[![Dependabot Status](https://api.dependabot.com/badges/status?host=github\&repo=yoanm/php-jsonrpc-http-server-swagger-doc-sdk)](https://dependabot.com)
5+
![Dependabot Status](https://flat.badgen.net/github/dependabot/yoanm/php-jsonrpc-http-server-swagger-doc-sdk)
6+
![Last commit](https://badgen.net/github/last-commit/yoanm/php-jsonrpc-http-server-swagger-doc-sdk)
67

78
[![Scrutinizer Build Status](https://img.shields.io/scrutinizer/build/g/yoanm/php-jsonrpc-http-server-swagger-doc-sdk.svg?label=Scrutinizer\&logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-http-server-swagger-doc-sdk/build-status/master)
89
[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/yoanm/php-jsonrpc-http-server-swagger-doc-sdk/master.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-http-server-swagger-doc-sdk/?branch=master)

phpunit.xml.dist

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
32
<!-- https://phpunit.de/manual/current/en/appendixes.configuration.html -->
43
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5-
xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.8/phpunit.xsd"
4+
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
65
backupStaticAttributes="false"
76
colors="true"
87
processIsolation="false"
@@ -24,22 +23,20 @@
2423

2524
bootstrap="vendor/autoload.php"
2625
>
27-
<listeners>
28-
<listener class="Yoanm\PhpUnitExtended\Listener\YoanmTestsStrategyListener"/>
29-
</listeners>
30-
31-
<testsuites>
32-
<testsuite name="functional">
33-
<directory>tests/Functional/*</directory>
34-
</testsuite>
35-
<testsuite name="technical">
36-
<directory>tests/Technical/*</directory>
37-
</testsuite>
38-
</testsuites>
39-
40-
<filter>
41-
<whitelist>
42-
<directory>src</directory>
43-
</whitelist>
44-
</filter>
26+
<coverage>
27+
<include>
28+
<directory>src</directory>
29+
</include>
30+
</coverage>
31+
<listeners>
32+
<listener class="Yoanm\PhpUnitExtended\Listener\YoanmTestsStrategyListener"/>
33+
</listeners>
34+
<testsuites>
35+
<testsuite name="functional">
36+
<directory>tests/Functional</directory>
37+
</testsuite>
38+
<testsuite name="technical">
39+
<directory>tests/Technical</directory>
40+
</testsuite>
41+
</testsuites>
4542
</phpunit>

0 commit comments

Comments
 (0)