Skip to content

Commit fb8252c

Browse files
committed
Release v1.0.5: align docs with GitHub SerialNumberBundle, demo ports, CHANGELOG
1 parent f98b338 commit fb8252c

13 files changed

Lines changed: 61 additions & 42 deletions

File tree

.github/ISSUE_TEMPLATE/---bug-report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ assignees: ''
88
---
99

1010
<!--
11-
- Please do not report an issue for a version of `serial-number-bundle` that is no longer supported. Currently supported versions are listed here: https://github.com/nowo-tech/SerialNumberBundle#version-information
11+
- Please do not report an issue for a version of `serial-number-bundle` that is no longer supported. See [Version policy](https://github.com/nowo-tech/SerialNumberBundle#version-policy) and [Supported versions](https://github.com/nowo-tech/SerialNumberBundle/security/policy#supported-versions) in the repository.
1212
- Please fill in this template according to your issue.
1313
- Please keep the table shown below at the top of your issue.
1414
- You can retrieve `serial-number-bundle` version by running `composer info | grep "serial-number-bundle"`.

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
77
[![PHP](https://img.shields.io/badge/PHP-8.1%2B-777BB4?logo=php)](https://php.net)
88
[![Symfony](https://img.shields.io/badge/Symfony-6%20%7C%207%20%7C%208-000000?logo=symfony)](https://symfony.com)
9-
[![GitHub stars](https://img.shields.io/github/stars/nowo-tech/serial-number-bundle.svg?style=social&label=Star)](https://github.com/nowo-tech/SerialNumberBundle) [![Coverage](https://img.shields.io/badge/Coverage-100%25-brightgreen)](#tests-and-coverage)
9+
[![GitHub stars](https://img.shields.io/github/stars/nowo-tech/SerialNumberBundle.svg?style=social&label=Star)](https://github.com/nowo-tech/SerialNumberBundle) [![Coverage](https://img.shields.io/badge/Coverage-100%25-brightgreen)](#tests-and-coverage)
1010

1111
> ⭐ **Found this useful?** Install from Packagist and give it a star on GitHub.
1212

@@ -70,6 +70,12 @@ $serial = $this->serialNumberGenerator->generate(
7070
- Tests: PHPUnit (PHP)
7171
- PHP: 100%
7272

73+
## Version policy
74+
75+
The Composer package name is [`nowo-tech/serial-number-bundle`](https://packagist.org/packages/nowo-tech/serial-number-bundle). Source code and issues are in the GitHub repository [`nowo-tech/SerialNumberBundle`](https://github.com/nowo-tech/SerialNumberBundle).
76+
77+
We follow [Semantic Versioning](https://semver.org/). See [Changelog](docs/CHANGELOG.md) for release notes. Security support by major version is described in the [Security policy](.github/SECURITY.md#supported-versions).
78+
7379
## License
7480

7581
MIT. See [LICENSE](LICENSE).

composer.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@
1313
"mask",
1414
"pattern"
1515
],
16-
"homepage": "https://github.com/nowo-tech/serial-number-bundle",
16+
"homepage": "https://github.com/nowo-tech/SerialNumberBundle",
1717
"support": {
18-
"issues": "https://github.com/nowo-tech/serial-number-bundle/issues",
19-
"source": "https://github.com/nowo-tech/serial-number-bundle",
20-
"docs": "https://github.com/nowo-tech/serial-number-bundle/tree/main/docs",
21-
"changelog": "https://github.com/nowo-tech/serial-number-bundle/blob/main/docs/CHANGELOG.md"
18+
"issues": "https://github.com/nowo-tech/SerialNumberBundle/issues",
19+
"source": "https://github.com/nowo-tech/SerialNumberBundle",
20+
"docs": "https://github.com/nowo-tech/SerialNumberBundle/tree/main/docs",
21+
"changelog": "https://github.com/nowo-tech/SerialNumberBundle/blob/main/docs/CHANGELOG.md"
2222
},
2323
"authors": [
2424
{

demo/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Serial Number Bundle – Demos
22

3-
Demos for [nowo-tech/serial-number-bundle](https://github.com/nowo-tech/serial-number-bundle) on Symfony 7 and 8.
3+
Demos for Composer package [nowo-tech/serial-number-bundle](https://packagist.org/packages/nowo-tech/serial-number-bundle) ([source on GitHub](https://github.com/nowo-tech/SerialNumberBundle)) on Symfony 7 and 8.
44

55
## Demos
66

7-
| Demo | Symfony | Port (default) |
8-
|------------|---------|----------------|
9-
| symfony7 | 7.0 | 8001 |
10-
| symfony8 | 8.0 | 8001 |
7+
| Demo | Symfony | Port (default in `.env.example`) |
8+
|------------|---------|----------------------------------|
9+
| symfony7 | 7.0 | 8007 |
10+
| symfony8 | 8.0 | 8008 |
1111

1212
## Quick start (from bundle root)
1313

@@ -19,7 +19,7 @@ make -C demo up-symfony8
1919
make -C demo up-symfony7
2020
```
2121

22-
Then open http://localhost:8001 (or the `PORT` in the demo’s `.env`).
22+
Then open `http://localhost:<PORT>` (e.g. http://localhost:8008 for Symfony 8, or the `PORT` in the demo’s `.env`).
2323

2424
## Path repository
2525

demo/symfony7/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Serial Number Bundle - Symfony 7 Demo
22

3-
Demo application for [nowo-tech/serial-number-bundle](https://github.com/nowo-tech/serial-number-bundle) on Symfony 7.0.
3+
Demo application for [`nowo-tech/serial-number-bundle`](https://packagist.org/packages/nowo-tech/serial-number-bundle) ([GitHub](https://github.com/nowo-tech/SerialNumberBundle)) on Symfony 7.0.
44

55
## Quick start
66

demo/symfony7/composer.lock

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

demo/symfony8/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Serial Number Bundle - Symfony 8 Demo
22

3-
Demo application for [nowo-tech/serial-number-bundle](https://github.com/nowo-tech/serial-number-bundle) on Symfony 8.0.
3+
Demo application for [`nowo-tech/serial-number-bundle`](https://packagist.org/packages/nowo-tech/serial-number-bundle) ([GitHub](https://github.com/nowo-tech/SerialNumberBundle)) on Symfony 8.0.
44

55
## Quick start
66

demo/symfony8/composer.lock

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/CHANGELOG.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
77
## Table of contents
88

99
- [Unreleased](#unreleased)
10+
- [1.0.5 - 2026-03-30](#105---2026-03-30)
1011
- [Changed](#changed)
1112
- [1.0.4 - 2026-03-13](#104---2026-03-13)
1213
- [Fixed](#fixed)
@@ -16,17 +17,23 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
1617
- [Added](#added-1)
1718
- [Changed](#changed-1)
1819
- [1.0.1 - 2026-03-12](#101---2026-03-12)
19-
- [Added](#added-1)
20+
- [Added](#added-2)
2021
- [Fixed](#fixed-1)
2122
- [1.0.0 - 2026-03-12](#100---2026-03-12)
22-
- [Added](#added-2)
23+
- [Added](#added-3)
2324
- [Security](#security)
2425

2526
## [Unreleased]
2627

28+
## [1.0.5] - 2026-03-30
29+
2730
### Changed
2831

29-
- **Documentation**: Corrected mask examples in README and USAGE (last four characters of `FAC-2025-01-00042` are `0042`). README requirements aligned with `composer.json` (PHP `< 8.6`). Makefile `help` lists `release-check-demos` as part of `release-check`. **DEMO-FRANKENPHP.md**: demo `bundles.php` example includes Twig Inspector (as in the repo demos). **SECURITY.md** rewritten in English to match the rest of the docs.
32+
- **Documentation and metadata:** GitHub URLs now use the real repository slug `nowo-tech/SerialNumberBundle` (the previous `nowo-tech/serial-number-bundle` path returned 404). The Composer package name remains `nowo-tech/serial-number-bundle`. Updated root `composer.json` (`homepage`, `support.*`) and demo `composer.lock` metadata for the path package.
33+
- **README:** Added [Version policy](https://github.com/nowo-tech/SerialNumberBundle#version-policy) (package name vs repo, SemVer, links to changelog and security policy). GitHub stars badge uses the correct repo slug.
34+
- **Demos:** `demo/README.md` default ports aligned with `.env.example` (Symfony 7 → 8007, Symfony 8 → 8008). [DEMO-FRANKENPHP.md](DEMO-FRANKENPHP.md) port section updated to match.
35+
- **Bug report template:** Links to version policy and security policy instead of a non-existent `#version-information` anchor.
36+
- **Documentation (carry-over from pre-release notes):** Mask examples in README/USAGE; README PHP constraint aligned with `composer.json` (`< 8.6`); Makefile `help` documents `release-check-demos` under `release-check`; DEMO-FRANKENPHP `bundles.php` example includes Twig Inspector; SECURITY.md in English.
3037

3138
## [1.0.4] - 2026-03-13
3239

@@ -79,9 +86,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
7986
- Enforce single-character mask in config and in Twig mask filter (multi-char uses first character only).
8087
- Treat negative `visibleLast` in `serial_number_mask` as zero to prevent huge `str_repeat` output.
8188

82-
[Unreleased]: https://github.com/nowo-tech/serial-number-bundle/compare/v1.0.4...HEAD
83-
[1.0.4]: https://github.com/nowo-tech/serial-number-bundle/releases/tag/v1.0.4
84-
[1.0.3]: https://github.com/nowo-tech/serial-number-bundle/releases/tag/v1.0.3
85-
[1.0.2]: https://github.com/nowo-tech/serial-number-bundle/releases/tag/v1.0.2
86-
[1.0.1]: https://github.com/nowo-tech/serial-number-bundle/releases/tag/v1.0.1
87-
[1.0.0]: https://github.com/nowo-tech/serial-number-bundle/releases/tag/v1.0.0
89+
[Unreleased]: https://github.com/nowo-tech/SerialNumberBundle/compare/v1.0.5...HEAD
90+
[1.0.5]: https://github.com/nowo-tech/SerialNumberBundle/releases/tag/v1.0.5
91+
[1.0.4]: https://github.com/nowo-tech/SerialNumberBundle/releases/tag/v1.0.4
92+
[1.0.3]: https://github.com/nowo-tech/SerialNumberBundle/releases/tag/v1.0.3
93+
[1.0.2]: https://github.com/nowo-tech/SerialNumberBundle/releases/tag/v1.0.2
94+
[1.0.1]: https://github.com/nowo-tech/SerialNumberBundle/releases/tag/v1.0.1
95+
[1.0.0]: https://github.com/nowo-tech/SerialNumberBundle/releases/tag/v1.0.0

docs/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing
22

3-
Contributions are welcome. Please open an issue or a pull request on the [GitHub repository](https://github.com/nowo-tech/serial-number-bundle).
3+
Contributions are welcome. Please open an issue or a pull request on the [GitHub repository](https://github.com/nowo-tech/SerialNumberBundle) (Composer package: `nowo-tech/serial-number-bundle`).
44

55
- Follow PSR-12 and the project's PHP-CS-Fixer configuration.
66
- Add tests for new behaviour. Tests live under `tests/Unit/` (isolated) and `tests/Integration/` (container/kernel). Run all with `make test`, or only `composer test-unit` / `composer test-integration`.

0 commit comments

Comments
 (0)