https://github.com/utopia-php/vcs
Lite & fast micro PHP vcs abstraction library that is **easy to use**.
https://github.com/utopia-php/vcs
Last synced: about 2 months ago
JSON representation
Lite & fast micro PHP vcs abstraction library that is **easy to use**.
- Host: GitHub
- URL: https://github.com/utopia-php/vcs
- Owner: utopia-php
- Created: 2023-02-13T11:01:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-18T11:44:48.000Z (3 months ago)
- Last Synced: 2025-03-27T22:11:07.402Z (2 months ago)
- Language: PHP
- Size: 313 KB
- Stars: 6
- Watchers: 6
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Utopia VCS
[](https://travis-ci.com/utopia-php/vcs)
[](https://appwrite.io/discord)
Utopia VCS is a simple and lite library for interacting with version control systems (VCS) in Utopia-PHP using adapters for different providers like GitHub, GitLab etc. This library is aiming to be as simple and easy to learn and use. This library is maintained by the [Appwrite team](https://appwrite.io).
## Getting Started
Install using composer:
```bash
composer require utopia-php/vcs
```
Init in your application:
```php
initializeVariables($installationId, $privateKey, $githubAppId);
// Perform the actions that you want, ex: create repository
$owner = '';
$name = '';
$isPrivate = true; // Set to false if you want to create a public repository
$repository = $github->createRepository($owner, $name, $private);
```
### Environment Variables
To configure your GitHub App properly, you'll need to set up the following environment variables in your environment or configuration file. These values are crucial for authenticating and interacting with the GitHub API on behalf of your GitHub App.
1. *PRIVATE_KEY*: You can generate this from your GitHub App settings.
```bash
PRIVATE_KEY = your-github-app-private-key
```
2. *GITHUB_APP_ID*: You can find this in the GitHub App dashboard.
```bash
GITHUB_APP_ID = your-github-app-id
```
3. *INSTALLATION_ID*: You can find this in the GitHub App installation settings after installation.
```bash
INSTALLATION_ID = your-github-app-installation-id
```
Remember to replace the placeholders (*your-github-app-private-key*, *your-github-app-id*, and *your-github-app-installation-id*) with the actual values from your GitHub App configuration.
By using these environment variables, you can ensure that sensitive information is kept separate from your codebase and can be easily managed across different environments without exposing sensitive data.
### Supported Adapters
VCS Adapters:
| Adapter | Status |
|---------|---------|
| GitHub | ✅ |
| GitLab | |
| Bitbucket | |
| Azure DevOps | |
`✅ - supported, 🛠 - work in progress`
## System Requirements
Utopia VCS requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible.
## Contributing
All code contributions - including those of people having commit access - must go through a pull request and approved by a core developer before being merged. This is to ensure proper review of all the code.
Fork the project, create a feature branch, and send us a pull request.
You can refer to the [Contributing Guide](CONTRIBUTING.md) for more info.
## Tests
To run tests, you first need to bring up the example Docker stack with the following command:
```bash
docker compose up -d --build
```
To run all unit tests, use the following Docker command:
```bash
docker compose exec tests ./vendor/bin/phpunit
```
## Copyright and license
The MIT License (MIT) [http://www.opensource.org/licenses/mit-license.php](http://www.opensource.org/licenses/mit-license.php)