Download the PHP package utopia-php/vcs without Composer
On this page you can find all versions of the php package utopia-php/vcs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download utopia-php/vcs
More information about utopia-php/vcs
Files in utopia-php/vcs
Package vcs
Short Description A simple library to integrate version control systems like GitHub, GitLab etc. to receive webhook events
License MIT
Informations about the package vcs
Utopia VCS
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.
Getting Started
Install using composer:
Init in your application:
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.
-
PRIVATE_KEY: You can generate this from your GitHub App settings.
-
GITHUB_APP_ID: You can find this in the GitHub App dashboard.
- INSTALLATION_ID: You can find this in the GitHub App installation settings after installation.
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 |
Detector Adapters:
Adapter | Status |
---|---|
CPP | ✅ |
Dart | ✅ |
Deno | ✅ |
Dotnet | ✅ |
Java | ✅ |
JavaScript | ✅ |
PHP | ✅ |
Python | ✅ |
Ruby | ✅ |
Swift | ✅ |
Bun | ✅ |
✅ - 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 for more info.
Tests
To run tests, you first need to bring up the example Docker stack with the following command:
To run all unit tests, use the following Docker command:
Copyright and license
The MIT License (MIT) http://www.opensource.org/licenses/mit-license.php
All versions of vcs with dependencies
adhocore/jwt Version ^1.1
utopia-php/framework Version 1.0.*
utopia-php/system Version 0.9.*
utopia-php/cache Version 0.10.*