Download the PHP package alexandre-daubois/release-genius without Composer

On this page you can find all versions of the php package alexandre-daubois/release-genius. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package release-genius

Release Genius

PHPUnit

Requirements

That's it!

Why this package?

This package is a simple tool to help you manage your changelog and versioning. It uses the Conventional Commits standard to generate the changelog. This standard is widely used in the open-source community and is a great way to ensure that your commit messages are understandable and easy to parse.

Unlike this package, this one is under the MIT license. This licence is more permissive than the GPL-3.0 licence. This can be a pain point for some projects, and it is the main motivation for creating Release Genius.

Installation

Usage

TL;DR

Available options

Initialize and upgrade the version

The first time you use the package, you may need to initialize it. This is required when you don't have any tag in your repository and no changelog file exists. You can do this by running the following command:

This will create a new file called CHANGELOG.md in the root of your project. Also, it will create a new tag. You will be prompted to enter the version number you want to use. The version number should follow the Semantic Versioning specification.

After the initialization, you can start using the package to manage your changelog and versioning. The package provides a few commands to help you with that. Imagine your current version is 1.0.0. You can upgrade the version by running the following command:

This will update the CHANGELOG.md file and create a new tag. The tag will not be pushed to the remote repository. This is something you need to do manually in order to ensure you're happy with the changes and the new version.

Vendors JSON files

If a package.json file exists in the root of your project, the version number will be updated in this file as well (if present). The same goes for a composer.json file.

Skip the commit and tag creation

If you want to create the tag and commit yourself to be extra careful, you can use the --no-commit option. Release Genius will only update the changelog and the vendor JSON files.

Generate a changelog

The changelog is generated thanks to your commit messages. All commits from the last tag to the current state of your repository will be used to generate it.

You can customize the output path of the changelog file by using the --path option. By default, the changelog file is created in the root of your project and is called CHANGELOG.md.

You can also choose the way to changelog file is generated. By default, the changelog file uses the prepend mode. This means that the new content is added at the beginning of the file. You can change this behavior by using the --mode option. The available modes are append, prepend and overwrite.

Manage remotes

This package will do its best to guess the remote repository URL. By default, it tries to find a remote called origin. If it fails, you can use the --remote option to specify the remote repository URL.

This will allow to generate a changelog with the correct links to the commits and versions comparison.

In case you don't use a guessable remote URL (because your hosting a private instance of Gitlab, for example), you can use the --remote-type option to specify the type of your remote repository. The available types are github, gitlab.

Specifying the type will help generate the good URL format, with your remote URL. The remote type always takes precedence over the automatic remote URL guessing.

All versions of release-genius with dependencies

PHP Build Version
Package Version
Requires php Version >=8.2
symfony/clock Version ^6.3|^7.0
symfony/console Version ^6.3|^7.0
symfony/process Version ^6.3|^7.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package alexandre-daubois/release-genius contains the following files

Loading the files please wait ....