Download the PHP package mattsqd/robovalidate without Composer

On this page you can find all versions of the php package mattsqd/robovalidate. 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 robovalidate

Robo Validate Commands

A group of Robo commands that run various validation tasks on local environments or pipelines

Installing

composer require mattsqd/robovalidate

Usage

Use vendor/bin/robo to execute Robo tasks.

Configuration

There are two ways to configure the commands.

  1. Pass options to the command as they run.
  2. Create (or update) a robo.yml in your root directory that holds the options.

Number two is the easiest as some options are arrays, and it gets very ugly trying to pass arrays at run time.

All the options live under the command.validate.options namespace in robo.yml.

Some commands share the same option, such as project-id. So changing it will affect all commands unless you move that key under the specific commands section. You can see an example of this with 'pattern' which is used in two commands.

If you'd like to initialize your robo.yml with what's in robo.example.yml, please use the command:

vendor/bin/robo validate:init-robo-yml

Quick Start

The quick start assumes:

This can be configured by creating robo.yml in your project root with the following content:

And run vendor/bin/robo validate:all

If any of the above does not apply you can either:

Please see robo.example.yml for an example of the defaults configured explicitly.

For each option, you only need to override the ones you want to change, you don't need to copy the entire file, although you can.

Configuring the robo.yml after running validate:init-robo-yml

Project ID

The first choice is whether to use project ID or not. Project ID is used in validating commit messages and branch names. Project ID is up to you if you want it. It's a good reference so you know you're committing to the correct project and also handy if you use BitBucket because issues have a project ID in them. If you do NOT want to use project ID, remove {$project_id} from robo.yml. This project's robo.yml does not use project ID, you can use it as an example.

Branch Names

Branch name schemes usually vary between projects, so make sure that all the branch names that you could use have a corresponding entry in valid-branch-names. For example:

Commit Messages

Commit messages are defaulted to more of a BitBucket style. GitHub uses a special set of words to link to an issue. You can view this projects robo.yml to see how enforcing those keywords would be possible. If you use project ID, you'll need to add that back into the pattern and help text.

Running in Continuous Integration

There is a working GitHub Action for this project that you should be able to copy into your project if you use GitHub Actions as well. It can be found at https://github.com/mattsqd/robovalidate/blob/1.x/.github/workflows/run-validation.yml.

Run validation with RoboValidate

The main thing to note is that vendor/bin/robo validate:commit-messages needs a target branch so it goes over only commits that are not in the current branch. By default, this is set to develop. If the branch your developers merge into is not develop, you can either change the value or pass a value like the same GitHub action does and pass in the target branch which is only availble during pull request events. That is why there are 2 separate steps and vendor/bin/robo validate:all is not called. Note that current branch is also passed because on PRs, in GitHub, it does not checkout the current branch cleanly. Instead, you are left at a new hash which is the merge commit of the current branch into the target branch. Therefore, all commits will be processed and the last commit will probably not pass validation, since GitHub creates a commit.


All versions of robovalidate with dependencies

PHP Build Version
Package Version
Requires consolidation/robo Version ^3.0.9 || ^4.0.1
php Version >=8.0.17
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 mattsqd/robovalidate contains the following files

Loading the files please wait ....