{"id":22266731,"url":"https://github.com/kamiyang/project_version","last_synced_at":"2026-02-02T14:04:32.627Z","repository":{"id":32467311,"uuid":"134700322","full_name":"KamiYang/project_version","owner":"KamiYang","description":"EXT:project_version to show the current version of your project, based on VERSION file or GIT, inside of your TYPO3 Backend","archived":false,"fork":false,"pushed_at":"2022-06-06T20:14:43.000Z","size":210,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-19T00:54:27.855Z","etag":null,"topics":["project","typo3-cms-extension","typo3-extension","version"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KamiYang.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-05-24T10:35:56.000Z","updated_at":"2021-09-01T13:04:25.000Z","dependencies_parsed_at":"2022-07-24T23:46:41.761Z","dependency_job_id":null,"html_url":"https://github.com/KamiYang/project_version","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/KamiYang/project_version","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KamiYang%2Fproject_version","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KamiYang%2Fproject_version/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KamiYang%2Fproject_version/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KamiYang%2Fproject_version/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KamiYang","download_url":"https://codeload.github.com/KamiYang/project_version/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KamiYang%2Fproject_version/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260301992,"owners_count":22988722,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["project","typo3-cms-extension","typo3-extension","version"],"created_at":"2024-12-03T10:23:46.445Z","updated_at":"2026-02-02T14:04:27.571Z","avatar_url":"https://github.com/KamiYang.png","language":"PHP","readme":"# Project Version (EXT:project_version)\n\n[![StyleCI](https://github.styleci.io/repos/134700322/shield?branch=master)](https://github.styleci.io/repos/134700322)\n[![Build Status](https://travis-ci.org/KamiYang/project_version.svg?branch=master)](https://travis-ci.org/KamiYang/project_version)\n[![Coverage Status](https://coveralls.io/repos/github/KamiYang/project_version/badge.svg?branch=master)](https://coveralls.io/github/KamiYang/project_version?branch=master)\n[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/KamiYang/project_version/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/KamiYang/project_version/?branch=master)\n\n## What is project version?\nProject version is a TYPO3  extension that adds an entry to the TYPO3 system information in the toolbar. This entry is based either on the common 'VERSION' file or on the local GIT revision.\n\n## How do I install it? \nFirst make sure you match the requirements:\n\n| Requirement | Version |\n| --- | --- |\n| TYPO3 | \\\u003e=8.7 \u003c9.6 |\n| php | \\\u003e= 7.0 |\n\n### Composer\nSimply require the extension from packagist: \n`composer require kamiyang/ext-projectversion`\n\nOr if you prefer typo3-ter:\n`composer require typo3-ter/projectversion`\n\n### TER\nNo composer available? No problem! You also can find this extension at TYPO3's Extension Repository (TER).\nYou can straight download it from inside your TYPO3 as long, as your TYPO3 is not in composer mode. \n\n## How do I use it?\n### \"VERSION\"-file\nNow, this is the easiest part. Create a file called `VERSION` (case sensitive) in your TYPO3 frontend docroot with the project version. This can be done like this: \n`$ echo 1.0.0-rc.3 \u003e /var/www/html/VERSION`\n\n### Custom Path\nYou can use your own filename and path. Note that this path still has to be accessible from your web docroot.\nThe configuration can be done in the ExtensionConfiguration. It is also possible to change the directory of the 'VERSION'-file. Only provide a directory path (with trailing slash '/') and it will automatically search for an file called 'VERSION'.\n\nExamples:\nWe assume that the web document root (`PATH_site`) is `/var/www/html`.\n\n| Configured Path | Absolute filename | \n| --- | --- |\n| (empty - default) | /var/www/html/VERSION |\n| MyVersion | /var/www/html/MyVersion |\n| typo3conf/ | /var/www/html/typo3conf/VERSION |\n| ./My/Custom/Version/File/In/Some/Nested/File/Structure | /var/www/html/./My/Custom/Version/File/In/Some/Nested/File/Structure|\n\n### GIT\nSince release 0.3.0 git is supported. This must be manually activated. In order to use git, make sure it's available!\nCommon case is that the local development environment is based on docker images. Many docker images do not have git out of the box available.\nTo activate it, simply move via your preferred web browser into the TYPO3 backend. For TYPO3 v8.7 - go to \"Extensions \u003e Project Version\" and configure the extension.\nThe configuration screen will look like this on default: \n\n![default extension configuration](Documentation/Images/DefaultConfig.png)\n\nThis has changed a bit in TYPO3 v9. To configure the extension go to \"Settings \u003e Configure extensions\" and filter for \"project version\".\nThe new configuration screen will look like this:\n\n![new default extension configuration screen](Documentation/Images/DefaultConfigTYPO3v9.png)\n\n#### Configuration possibilities\n\n##### basic.mode\n\n| Configuration | Description |\n| --- | --- |\n| VERSION File (default)| Fetches the current project version based on the path configured in `basic.versionFilePath` |\n| GIT | Uses GIT if available to resolve the project version in the format configured in `basic.gitFormat` |\n| GIT (VERSION file as fallback) | Will use GIT as preferred resolving method. If not available will fallback to VERSION file. |\n\n\n##### basic.gitFormat\n\n| Configuration | Description | Example |\n| --- | --- | --- |\n| Revision | Will only fetch the revision as project version | ![git revision example ](Documentation/Images/BasicGitFormatRevision.png) |\n| \\[revision] Branch (default) | Will fetch the current revision and branch | ![git revision and branch example ](Documentation/Images/BasicGitFormatRevisionAndBranch.png) | \n| \\[revision] Tag | Will fetch the current revision and tag | ![git revision and tag example ](Documentation/Images/BasicGitFormatRevisionAndTag.png) | \n| Branch | Will only fetch the current branch | ![git branch example ](Documentation/Images/BasicGitFormatRevisionBranch.png) |\n| Tag | Will only fetch the current tag | ![git tag example ](Documentation/Images/BasicGitFormatRevisionTag.png) | \n\n## Roadmap to v1.0.0\n \n - [x] Static VERSION file support\n - [x] Add ability to configure \"VERSION\"-file path\n - [x] GIT revision support\n - [x] GIT tag/branch based on revision support\n - [x] Add documentation of this extensions features\n - [x] Upload extension to packagist.org\n - [x] Upload extension to TER\n - [x] Support TYPO3 v9.4\n - [x] Support TYPO3 v9 LTS\n - [x] Achieve overall test coverage above 95%  \n - [x] Configure [TravisCI](https://travis-ci.org/KamiYang/project_version)\n - [x] Configure [StyleCI](https://github.styleci.io/repos/134700322)\n - [x] Configure [Coveralls](https://coveralls.io/github/KamiYang/project_version)\n - [x] Static VERSION value via extension configuration\n\n### Milestone for v0.6.0\n - Ability to \"hardcode\" static project version via the TYPO3 backend\n\n## Note\nThe TYPO3 v8 version of this extension will not be maintained after release 1.0.0! But this should be no problem because TYPO3 v8 only gets bugfixes.\nThis means, version 1.0.0 should stay compatible with all further TYPO3 v8 releases!\n\nAfter releasing version 1.0.0, which will be around the release of the first TYPO3 v9 LTS version, EXT:project_version will be refactored to php7.2 and will integrate TYPO3 v9 features.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkamiyang%2Fproject_version","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkamiyang%2Fproject_version","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkamiyang%2Fproject_version/lists"}