37f7b426b6
Implements automatic creation of required plugin pages (Community Login, Trainer Registration, Trainer Dashboard) upon plugin activation. This addresses E2E test failures caused by missing pages in the test environment. - Adds activation hook in `hvac-community-events.php` to call `hvac_ce_create_required_pages`. - The callback function checks for existing pages by slug and creates them using `wp_insert_post` if missing. Includes debug logging. Also fixes issues identified during E2E test debugging: - Corrects fatal error in `includes/community/class-login-handler.php` by replacing undefined constant `HVAC_COMMUNITY_EVENTS_PATH` with `HVAC_CE_PLUGIN_DIR`. - Updates `tests/e2e/tests/login.spec.ts` to use the correct selector `#wp-submit` for the login form submit button instead of `button[type="submit"]`. Documentation updates: - Adds `docs/automatic-page-creation-plan.md`. - Updates `README.md` regarding automatic page creation. - Updates Memory Bank files (`decisionLog.md`, `progress.md`, `activeContext.md`). Note: Activation hook logging did not appear during WP-CLI activation, requiring further investigation if page creation issues persist. E2E test confirmation pending.
43 lines
2 KiB
Markdown
43 lines
2 KiB
Markdown
# Version
|
|
|
|
**Version** is a library that helps with managing the version number of Git-hosted PHP projects.
|
|
|
|
## Installation
|
|
|
|
You can add this library as a local, per-project dependency to your project using [Composer](https://getcomposer.org/):
|
|
|
|
composer require sebastian/version
|
|
|
|
If you only need this library during development, for instance to run your project's test suite, then you should add it as a development-time dependency:
|
|
|
|
composer require --dev sebastian/version
|
|
|
|
## Usage
|
|
|
|
The constructor of the `SebastianBergmann\Version` class expects two parameters:
|
|
|
|
* `$release` is the version number of the latest release (`X.Y.Z`, for instance) or the name of the release series (`X.Y`) when no release has been made from that branch / for that release series yet.
|
|
* `$path` is the path to the directory (or a subdirectory thereof) where the sourcecode of the project can be found. Simply passing `__DIR__` here usually suffices.
|
|
|
|
Apart from the constructor, the `SebastianBergmann\Version` class has a single public method: `getVersion()`.
|
|
|
|
Here is a contrived example that shows the basic usage:
|
|
|
|
<?php
|
|
$version = new SebastianBergmann\Version(
|
|
'3.7.10', '/usr/local/src/phpunit'
|
|
);
|
|
|
|
var_dump($version->getVersion());
|
|
?>
|
|
|
|
string(18) "3.7.10-17-g00f3408"
|
|
|
|
When a new release is prepared, the string that is passed to the constructor as the first argument needs to be updated.
|
|
|
|
### How SebastianBergmann\Version::getVersion() works
|
|
|
|
* If `$path` is not (part of) a Git repository and `$release` is in `X.Y.Z` format then `$release` is returned as-is.
|
|
* If `$path` is not (part of) a Git repository and `$release` is in `X.Y` format then `$release` is returned suffixed with `-dev`.
|
|
* If `$path` is (part of) a Git repository and `$release` is in `X.Y.Z` format then the output of `git describe --tags` is returned as-is.
|
|
* If `$path` is (part of) a Git repository and `$release` is in `X.Y` format then a string is returned that begins with `X.Y` and ends with information from `git describe --tags`.
|