Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion .github/workflows/php.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ on:
branches: [ main ]
pull_request:

concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
Expand All @@ -23,7 +27,7 @@ jobs:
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
tools: composer:v2, phpdoc
tools: composer:v2
- name: Validate composer.json and composer.lock
run: composer validate --strict
- name: Cache Composer packages
Expand All @@ -38,3 +42,9 @@ jobs:
run: composer install --prefer-dist --no-progress
- name: Run test suite
run: composer test
- name: Upload code coverage
uses: codecov/codecov-action@v5
with:
token: ${{ secrets.CODECOV_TOKEN }}
verbose: true
files: coverage.xml
10 changes: 10 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,20 @@ node_modules/

# user-configured files
# PHPUnit
phpunit.xml
.phpunit.xml
.phpunit.cache
.phpunit.result.cache

# phpDocumentor
.phpdoc
phpdoc.xml
docs/build/
docs/cache/

# code coverage
coverage
coverage.*

# PHPActor LSP
.phpactor.json
24 changes: 13 additions & 11 deletions LIBRARY.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
# `author/package`

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![GitHub deployments](https://img.shields.io/github/deployments/neoncitylights/php-template/github-pages?label=deploy)](https://github.com/neoncitylights/php-template/deployments/activity_log?environment=github-pages)
[![PHP CI](https://github.com/neoncitylights/php-template/actions/workflows/php.yml/badge.svg)](https://github.com/neoncitylights/php-template/actions/workflows/php.yml)
# author/package
[![License][license-badge]][license-url]
[![Docs][docs-badge]][docs-url]
[![CI][ci-badge]][ci-url]

[license-badge]: https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square
[license-url]: #license
[docs-badge]: https://img.shields.io/github/deployments/neoncitylights/php-template/github-pages?label=deploy&style=flat-square
[docs-url]: https://neoncitylights.github.io/php/
[ci-badge]: https://img.shields.io/github/actions/workflow/status/neoncitylights/php/.github/workflows/php.yml?style=flat-square
[ci-url]: https://github.com/neoncitylights/php/actions/workflows/php.yml

Describe the library.

## Install

```shell
```sh
composer install author/package
```

## Usage

```php
use Neoncitylights\ExampleLibrary\Dog;

Expand All @@ -22,9 +26,7 @@ $dog->bark(); // "Woof!"
```

## License

This software is licensed under the MIT license ([`LICENSE-MIT`](./LICENSE) or <http://opensource.org/licenses/MIT>).
This software is licensed under the MIT license ([`LICENSE`](./LICENSE) or <http://opensource.org/licenses/MIT>).

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the MIT license, shall be licensed as above, without any additional terms or conditions.
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"mediawiki/minus-x": "1.1.3",
"php-parallel-lint/php-parallel-lint": "1.4.0",
"php-parallel-lint/php-console-highlighter": "1.0.0",
"phpunit/phpunit": "11.5.0"
"phpunit/phpunit": "11.5.1"
},
"scripts": {
"test": [
Expand Down
Loading
Loading