Download the PHP package metadrop/drupal-artifact-builder without Composer

On this page you can find all versions of the php package metadrop/drupal-artifact-builder. 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 drupal-artifact-builder

Drupal artifact builder

Helps generating artifacts for Drupal by wrapping all code into an artifact, and pushing it to the artifact remote repository.

Table of contents

Installation

Configuration

Drupal artifact builder allow using a configuration file to create the artifact. Artifacts usually are executed using always the same parameters. So, a configuration file saves time adding those parameters every time the command is run.

Configuration file is placed at root (it can be changed through command line parameters). You cam copy the template to have an starting point:

Configuration properties

This example will make push the artifacts coming from develop source branch to the develop-build artifact branch.

Usage

Important: Please note that Drupal Artifact Builder does not download Composer libraries or compile CSS assets. These tasks must be completed prior to running the command.

Builds the artifact and push the changes to git:

Generate the artifact:

Push the created artifact to git:

Parameters

CI integration

GitHub Actions

A ready-to-use workflow is available at examples/github-actions.yml. Copy it into your Drupal project at .github/workflows/deploy-artifact.yml and follow these steps:

  1. Generate an SSH key pair for the artifact repository:

  2. Add the public key (artifact_deploy_key.pub) as a deploy key with write access in the artifact repository settings (Settings > Deploy keys).

  3. Add the private key (artifact_deploy_key) as a repository secret named ARTIFACT_DEPLOY_KEY in the source Drupal repository (Settings > Secrets and variables > Actions).

  4. Adjust the workflow to your needs:
    • Update the branches list under on.push to match the branches you want to deploy.
    • Change the Docker image tag (php8.3-node20) to match your PHP and Node versions. Available tags are listed in the drupal-artifact-builder-docker repository.

Prerequisites: Before running the workflow, make sure .drupal-artifact-builder.yml is correctly configured in your project root as described in the Configuration section. At minimum, the repository key must point to the artifact repository.

The workflow runs inside the ghcr.io/metadrop/drupal-artifact-builder-docker image, which provides PHP, Composer, Node, and Git out of the box. You can replace this image with any other, as long as it includes PHP, Composer, and Git.

Upgrade from 1.x to 2.x

2.0.0 release brings breaking changes and the way to use drupal-artifact-builder changes.

These steps must be followed in order to upgrade to the 2.0.0 version:

  1. Copy and configure .drupal-artifact-builder.yml:

  2. Change --extra-paths parameters to --include

    Before:

    Now:

  3. Stop using GIT_BRANCH environment variable, now it is --branch

    Before:

    Now:

Upgrade from 2.x to 3.x

To be able to bring composer libraries and compile the custom theme, configure commands in .drupal-artifact-builder.yml.

Example:

All versions of drupal-artifact-builder with dependencies

PHP Build Version
Package Version
No informations.
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 metadrop/drupal-artifact-builder contains the following files

Loading the files please wait ...