Skip to content

Commit

Permalink
Fill package information
Browse files Browse the repository at this point in the history
  • Loading branch information
cerbero90 committed Jul 2, 2022
1 parent cc7402f commit fc9d27f
Show file tree
Hide file tree
Showing 9 changed files with 30 additions and 221 deletions.
6 changes: 2 additions & 4 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,11 @@ jobs:
strategy:
fail-fast: false
matrix:
php: [8.0, 8.1]
laravel: [8.*, 9.*]
php: [8.1]
dependency-version: [prefer-stable]
os: [ubuntu-latest]

name: PHP ${{ matrix.php }} - Laravel ${{ matrix.laravel }} - ${{ matrix.dependency-version }} - ${{ matrix.os }}
name: PHP ${{ matrix.php }} - ${{ matrix.dependency-version }} - ${{ matrix.os }}

steps:
- name: Checkout code
Expand All @@ -32,7 +31,6 @@ jobs:

- name: Install dependencies
run: |
composer require "illuminate/contracts=${{ matrix.laravel }}" --no-interaction --no-update
composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction
- name: Execute tests
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Changelog

All notable changes to `:package_name` will be documented in this file.
All notable changes to `enum` will be documented in this file.

Updates should follow the [Keep a CHANGELOG](https://keepachangelog.com/) principles.

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Contributions are **welcome** and will be fully **credited**.

We accept contributions via Pull Requests on [Github](https://github.com/cerbero90/:package_name).
We accept contributions via Pull Requests on [Github](https://github.com/cerbero90/enum).


## Pull Requests
Expand Down
45 changes: 15 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# :package_title
# Enum

[![Author][ico-author]][link-author]
[![PHP Version][ico-php]][link-php]
[![Laravel Version][ico-laravel]][link-laravel]
[![Octane Compatibility][ico-octane]][link-octane]
[![Build Status][ico-actions]][link-actions]
[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
[![Quality Score][ico-code-quality]][link-code-quality]
Expand All @@ -12,29 +10,20 @@
[![PSR-12][ico-psr12]][link-psr12]
[![Total Downloads][ico-downloads]][link-downloads]

:package_description
PHP library to extend enum functionalities.


## 📦 Install

Via Composer:

``` bash
composer require cerbero/:package_name
composer require cerbero/enum
```

## 🔮 Usage

1. Create a new package by [using this template](https://github.com/cerbero90/skeleton/generate)
1. Clone the newly created repository
1. Run `php prefill.php`
1. Delete `prefill.php`
1. Review versions of PHP and Laravel to support in [composer.json](composer.json), [build.yml](.github/workflows/build.yml) and [README badges](README.md)
1. Push changes to master
1. Submit package to [Packagist](https://packagist.org/packages/submit)
1. Add repository to [Scrutinizer](https://scrutinizer-ci.com/g/new)
1. Initialize GitFlow
1. Happy coding!
// @TODO

## 📆 Change log

Expand Down Expand Up @@ -64,25 +53,21 @@ If you discover any security related issues, please email andrea.marco.sartori@g
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

[ico-author]: https://img.shields.io/static/v1?label=author&message=cerbero90&color=50ABF1&logo=twitter&style=flat-square
[ico-php]: https://img.shields.io/packagist/php-v/cerbero/:package_name?color=%234F5B93&logo=php&style=flat-square
[ico-laravel]: https://img.shields.io/static/v1?label=laravel&message=%E2%89%A55.5&color=ff2d20&logo=laravel&style=flat-square
[ico-octane]: https://img.shields.io/static/v1?label=octane&message=compatible&color=ff2d20&logo=laravel&style=flat-square
[ico-version]: https://img.shields.io/packagist/v/cerbero/:package_name.svg?label=version&style=flat-square
[ico-actions]: https://img.shields.io/github/workflow/status/cerbero90/:package_name/build?style=flat-square&logo=github
[ico-php]: https://img.shields.io/packagist/php-v/cerbero/enum?color=%234F5B93&logo=php&style=flat-square
[ico-version]: https://img.shields.io/packagist/v/cerbero/enum.svg?label=version&style=flat-square
[ico-actions]: https://img.shields.io/github/workflow/status/cerbero90/enum/build?style=flat-square&logo=github
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-psr12]: https://img.shields.io/static/v1?label=compliance&message=PSR-12&color=blue&style=flat-square
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/cerbero90/:package_name.svg?style=flat-square&logo=scrutinizer
[ico-code-quality]: https://img.shields.io/scrutinizer/g/cerbero90/:package_name.svg?style=flat-square&logo=scrutinizer
[ico-downloads]: https://img.shields.io/packagist/dt/cerbero/:package_name.svg?style=flat-square
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/cerbero90/enum.svg?style=flat-square&logo=scrutinizer
[ico-code-quality]: https://img.shields.io/scrutinizer/g/cerbero90/enum.svg?style=flat-square&logo=scrutinizer
[ico-downloads]: https://img.shields.io/packagist/dt/cerbero/enum.svg?style=flat-square

[link-author]: https://twitter.com/cerbero90
[link-php]: https://www.php.net
[link-laravel]: https://laravel.com
[link-octane]: https://github.com/laravel/octane
[link-packagist]: https://packagist.org/packages/cerbero/:package_name
[link-actions]: https://github.com/cerbero90/:package_name/actions?query=workflow%3Abuild
[link-packagist]: https://packagist.org/packages/cerbero/enum
[link-actions]: https://github.com/cerbero90/enum/actions?query=workflow%3Abuild
[link-psr12]: https://www.php-fig.org/psr/psr-12/
[link-scrutinizer]: https://scrutinizer-ci.com/g/cerbero90/:package_name/code-structure
[link-code-quality]: https://scrutinizer-ci.com/g/cerbero90/:package_name
[link-downloads]: https://packagist.org/packages/cerbero/:package_name
[link-scrutinizer]: https://scrutinizer-ci.com/g/cerbero90/enum/code-structure
[link-code-quality]: https://scrutinizer-ci.com/g/cerbero90/enum
[link-downloads]: https://packagist.org/packages/cerbero/enum
[link-contributors]: ../../contributors
24 changes: 9 additions & 15 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
{
"name": "cerbero/:package_name",
"name": "cerbero/enum",
"type": "library",
"description": ":package_description",
"description": "PHP library to extend enum functionalities.",
"keywords": [
"laravel"
"enum",
"enumeration"
],
"homepage": "https://github.com/cerbero90/:package_name",
"homepage": "https://github.com/cerbero90/enum",
"license": "MIT",
"authors": [{
"name": "Andrea Marco Sartori",
Expand All @@ -14,23 +15,21 @@
"role": "Developer"
}],
"require": {
"php": "^8.0",
"illuminate/support": ">=8.0"
"php": "^8.1"
},
"require-dev": {
"orchestra/testbench": ">=6.0",
"pestphp/pest": "^1.21",
"scrutinizer/ocular": "^1.8",
"scrutinizer/ocular": "^1.9",
"squizlabs/php_codesniffer": "^3.0"
},
"autoload": {
"psr-4": {
"Cerbero\\:package_ns\\": "src"
"Cerbero\\Enum\\": "src"
}
},
"autoload-dev": {
"psr-4": {
"Cerbero\\:package_ns\\": "tests"
"Cerbero\\Enum\\": "tests"
}
},
"scripts": {
Expand All @@ -41,11 +40,6 @@
"extra": {
"branch-alias": {
"dev-master": "1.0-dev"
},
"laravel": {
"providers": [
"Cerbero\\:package_ns\\Providers\\:package_nsServiceProvider"
]
}
},
"config": {
Expand Down
4 changes: 2 additions & 2 deletions phpcs.xml.dist
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
<ruleset name=":package_name">
<description>The coding standard of :package_name package</description>
<ruleset name="enum">
<description>The coding standard of enum package</description>
<arg value="p" />

<config name="ignore_warnings_on_exit" value="1" />
Expand Down
110 changes: 0 additions & 110 deletions prefill.php

This file was deleted.

32 changes: 0 additions & 32 deletions src/Providers/RenameMeServiceProvider.php

This file was deleted.

26 changes: 0 additions & 26 deletions tests/RenameMeTest.php

This file was deleted.

0 comments on commit fc9d27f

Please sign in to comment.