d3p1 / module-sticky-header
d3p1/module-sticky-header
Sticky header
[LIBRARY PHP TEMPLATE]
Introduction
A template to build PHP libraries.
The goal of this template is to simplify the process of creating, maintaining, and publishing libraries. It provides a ready-to-use setup with sensible defaults, including an automated release workflow triggered on every push to the repository.
Usage
Using this library is straightforward:
1. Create a repository
Click the Use this template button to create a new repository based on this template.
2. Update composer.json
Edit the composer.json file to reflect your library’s metadata:
name– Your library namedescription– Short and meaningful descriptionauthors– Author informationrequire- Library dependenciesautoload- Autoload configuration
3. Install dependencies
Execute the following commands:
composer install
4. Develop your library
Start developing your library inside the src folder.
Every commit must follow this Conventional Commits format:
<type>(<scope>): <description> [<issue-number>]
[!NOTE]
This is required by the release workflow, which analyzes every commit to automatically generate the releases.
5. Finalize documentation
Update the README.md to describe your library’s purpose and usage.
[!IMPORTANT]
Don’t forget to update the release badge URL at the top of this file if you keep it — it currently points to this repository.
[!NOTE]
To gain a deeper understanding of how to use this library and how it works under the hood, visit the wiki page (in progress).
[!NOTE]
There is a ticket to add testing tools to improve the library's validation workflow.
Changelog
Detailed changes for each release are documented in CHANGELOG.md.
License
This work is published under MIT License.
Author
Always happy to receive a greeting on:
Requires 3
| Package | Constraint |
|---|---|
| magento/framework | ~101.0||~102.0||~103.0 |
| magento/module-theme | ~101.0 |
| php | ^7.0.0||^8.0.0 |
Compatibility
Each Magento release line is installed on its supported PHP versions, then the module is built (DI compilation + static-content deploy) and its unit and integration suites are run. The matrix shows the lines and PHP versions the module is confirmed to install and run on. Code-quality results further down (phpstan, phpcs, …) are reported separately and never affect compatibility.
Code Quality
Advisory checks against the module's source. Static analysis runs once across the whole module; PHPStan re-runs per Magento + PHP version because resolvable symbols differ between releases. These NEVER affect the Compatibility badge — a phpcs finding can't make a module incompatible.
Static analysis
Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.
PHPStan
Type-checks the module's PHP against a real Magento install at the configured gate level. Re-runs per Magento and PHP version because resolvable symbols differ between releases. Cell → details modal.
Tests
Unit and integration suites, run for each applicable Magento and PHP version. A test failure speaks to the module's behaviour, not its compatibility with a Magento line, so it is reported here separately and never reddens the compatibility matrix.
Unit tests
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | ||
| 2.4.8 | N/A | N/A | ||
| 2.4.9 | N/A | N/A |
Integration tests
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | ||
| 2.4.8 | N/A | N/A | ||
| 2.4.9 | N/A | N/A |
Security
Security checks run directly against the module: an audit of its declared dependencies for known vulnerabilities (composer audit) and a scan of its source for malware and web-shell signatures. Each runs once. A malware detection fails the version outright.
More from d3p1
View vendorTurn an existing module into recurring revenue.
If you already maintain a Magento 2 module on GitHub or GitLab, listing it on Packagento takes about five minutes. We mirror your tags, handle distribution signing, and route paid licenses through Stripe Connect, so you can keep shipping the way you already do.