Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/68publishers/tracy-git-version
:twisted_rightwards_arrows: Git version panel for Tracy
https://github.com/68publishers/tracy-git-version
build git nette tracy tracy-debugger tracy-panel vcs version
Last synced: about 10 hours ago
JSON representation
:twisted_rightwards_arrows: Git version panel for Tracy
- Host: GitHub
- URL: https://github.com/68publishers/tracy-git-version
- Owner: 68publishers
- License: mit
- Created: 2021-12-30T01:33:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-26T03:03:36.000Z (about 1 year ago)
- Last Synced: 2024-09-18T20:07:28.820Z (9 days ago)
- Topics: build, git, nette, tracy, tracy-debugger, tracy-panel, vcs, version
- Language: PHP
- Homepage:
- Size: 268 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Tracy Git version
Simple and extensible panel for [Tracy](https://github.com/nette/tracy) that shows information from Git.
## Table of contents
* [Installation](#installation)
* [Basic integration](#basic-integration)
* [Solution for application builds without Git](#solution-for-application-builds-without-git)
* [Advanced guide](#advanced-guide)
* [Contributing](#contributing)
* [License](#license)
## Installation
The best way to install `68publishers/tracy-git-version` is using Composer:
```bash
$ composer require 68publishers/tracy-git-version
```
## Basic integration
### Standalone Tracy integration
The simplest way how to register the panel into Tracy is by creating a default instance and providing it directly into a Bar.
```php
use Tracy\Debugger;
use SixtyEightPublishers\TracyGitVersion\Bridge\Tracy\GitVersionPanel;
Debugger::getBar()->addPanel(GitVersionPanel::createDefault());
```
### Integration into Nette Framework
Basic integration into Nette is really simple. Just register an extension.
```neon
extensions:
68publishers.tracy_git_version: SixtyEightPublishers\TracyGitVersion\Bridge\Nette\DI\TracyGitVersionExtension
```
And everything works 😉
## Solution for application builds without Git
Often when we deploy an application to a production environment, neither Git nor the `.git` directory is available due to trying to have a build as small as possible.
However, at this moment we have no source of information about the current version. The solution is to export a file that contains all important information at the time when the Git is still accessible.
### Setup for standalone Tracy
You must create repositories and the panel manually but there is not much work to do.
```php
use Tracy\Debugger;
use SixtyEightPublishers\TracyGitVersion\Bridge\Tracy\GitVersionPanel;
use SixtyEightPublishers\TracyGitVersion\Repository\LocalGitRepository;
use SixtyEightPublishers\TracyGitVersion\Repository\ExportedGitRepository;
use SixtyEightPublishers\TracyGitVersion\Repository\ResolvableGitRepository;
use SixtyEightPublishers\TracyGitVersion\Repository\RuntimeCachedGitRepository;
use SixtyEightPublishers\TracyGitVersion\Bridge\Tracy\Block\CurrentStateBlock;
# create a repository that reads from the .git directory:
$localGitRepository = LocalGitRepository::createDefault();
# create a repository that reads from a JSON export:
$exportedGitRepository = ExportedGitRepository::createDefault('/var/git-version/repository.json');
# combine there two repositories, if the .git directory is not accessible then try to read from the export file:
$resolvableGitRepository = new ResolvableGitRepository([$localGitRepository, $exportedGitRepository]);
# add runtime cache, commands results are stored so there are no duplicated calls to the real repository:
$cachedGitRepository = new RuntimeCachedGitRepository($resolvableGitRepository);
# add the panel into Tracy
Debugger::getBar()->addPanel(new GitVersionPanel($cachedGitRepository, [new CurrentStateBlock()]));
```
### Setup for Nette Framework
The setup for Nette is more simple. Just add another extension into your neon configuration.
```neon
extensions:
68publishers.tracy_git_version: SixtyEightPublishers\TracyGitVersion\Bridge\Nette\DI\TracyGitVersionExtension
68publishers.tracy_git_version.export: SixtyEightPublishers\TracyGitVersion\Bridge\Nette\DI\TracyGitVersionExportExtension
```
The default name for the exported file is `%tempDir%/git-version/repository.json` but you can change it.
```neon
68publishers.tracy_git_version.export:
export_filename: %tempDir%/my/custom/path.json
```
### Creating the export file
The export file should be created by executing a script that is located in the composer's `bin` directory.
The script is independent of the application so you must provide the filename of the exported file as an option.
```bash
$ vendor/bin/tracy-git-version export-repository --output-file /git-version/repository.json -vv
```
## Advanced guide
If you want to read more about repositories, how to extend them or how to add custom data into the panel, please see the [Advanced guide](docs/advanced-guide.md).
## Contributing
Before opening a pull request, please check your changes using the following commands
```bash
$ make init # to pull and start all docker images
$ make cs.check
$ make stan
$ make tests.all
```
## License
The package is distributed under the MIT License. See [LICENSE](LICENSE.md) for more information.