Download the PHP package drevops/git-artifact without Composer
On this page you can find all versions of the php package drevops/git-artifact. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download drevops/git-artifact
More information about drevops/git-artifact
Files in drevops/git-artifact
Package git-artifact
Short Description Build artifact from your codebase in CI and push it to a separate git repo.
License GPL-2.0-or-later
Homepage https://github.com/drevops/git-artifact
FAQ
Example:
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 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.
Informations about the package git-artifact
Package and push files to a remote repository
[](https://github.com/drevops/git-artifact/issues)
[](https://github.com/drevops/git-artifact/pulls)
[](https://codecov.io/gh/drevops/git-artifact)
[](https://packagist.org/packages/drevops/git-artifact)
[](https://github.com/drevops/git-artifact/actions/workflows/test-php.yml)
[](https://circleci.com/gh/drevops/git-artifact)
What is it?
A tool to assemble a code artifact from your codebase, remove unnecessary files, and push it into a separate Git repository.
Why?
In hosting environments like Acquia, there are restrictions on the languages or frameworks available for building applications—for instance, the inability to run composer install due to a read-only filesystem. Consequently, a website must be developed in a separate (source) repository, compiled into an artifact either locally or via CI, and then transferred to the hosting provider's version control system (destination repository).
This tool facilitates such processes seamlessly: it uses a .gitignore.deployment
file to determine which files should be transferred to the destination
repository, ensuring only necessary files are included and leaving out those
specified by the ignore file.
Furthermore, since the destination repository requires a commit to incorporate
changes from the artifact (like CSS, JS, etc.), the tool offers two options for
this commit: force-push or branch, accommodating different workflow
preferences.
See example of deployed artifact in Artifact branches.
Modes
force-push mode (default)
Push the packaged artifact to the same branch in the destination repository, carrying over the history from the source repository while overwriting the existing history in the destination repository.
Use case
Forwarding all changes from the source repository to the destination
repository as-is for every branch: for example, a commit in the source
repository branch feature/123 would create a commit in the destination
repository branch feature/123. The next commit to the source repository
branch feature/123 would update the destination repository branch
feature/123 with the changes, but would overwrite the last "deployment"
commit.
branch mode
Push packaged artifact to the new branch on each deployment, preserving history from the source repository, but requiring to trigger a deployment of newly created branch after each deployment.
Use case
Creating a new branch in the destination repository for every tag
created in the source repository: for example, a tag 1.2.3 in the source
repository would create a branch deployment/1.2.3 in the destination
repository. The addition of the new tags would create new unique branches in the
destination repository.
Installation
or download the latest release from the GitHub releases page.
Usage
This will create an artifact from current directory and will send it to the specified remote repository into the same branch as a current one.
Run in CI
See examples:
- GitHub Actions
- CircleCI
Call from CI configuration or deployment script:
See extended and fully-configured example in the DrevOps project.
Options
| Name | Default value | Description |
|---|---|---|
--branch |
"[branch]" |
Destination branch with optional tokens. |
--gitignore |
Path to gitignore file to replace current .gitignore. |
|
--message |
"Deployment commit" |
Commit message with optional tokens. |
--mode |
"force-push" |
Mode of artifact build: branch, force-push or diff. |
--no-cleanup |
Do not cleanup after run. | |
--now |
Internal value used to set internal time. | |
--dry-run |
Run without pushing to the remote repository. | |
--log |
Path to the log file. | |
--root |
Path to the root for file path resolution. Uses current directory if not specified. | |
--show-changes |
Show changes made to the repo by the build in the output. | |
--src |
Directory where source repository is located. Uses root directory if not specified. | |
-h, --help |
Display help for the given command. Displays help for the artifact command if no command given. | |
-q, --quiet |
Do not output any message. | |
-V, --version |
Display this application version. | |
--ansi |
Force ANSI output. Use --no-ansi to disable. |
|
-n, --no-interaction |
Do not ask any interactive question. | |
-v, --verbose |
Increase the verbosity of messages: 1 for normal, 2 for more verbose, 3 for debug. |
Modifying artifact content
--gitignore option allows to specify the path to the artifact's .gitignore
file that replaces existing .gitignore (if any) during the build. Any files no
longer ignored by the replaced artifact's .gitignore are added into the
deployment commit. If there are no no-longer-excluded files, the deployment
commit is still created, to make sure that the deployment timestamp is
captured.
Token support
Tokens are pre-defined strings surrounded by [ and ] and may contain
optional formatter (for flexibility). For example, [timestamp:Y-m-d] is
replaced with current timestamp in format Y-m-d (token formatter), which is
PHP date() expected format.
Both --branch and --message option values support token replacement.
Available tokens:
[timestamp:FORMAT]- current time with a PHPdate()-compatibleFORMAT.[branch]- current branch in the source repository.[tags:DELIMITER]- tags from the latest commit in the source repository separated by aDELIMITER.
Maintenance
Lint code
Run tests
Repository created using https://getscaffold.dev/ project scaffold template
All versions of git-artifact with dependencies
czproject/git-php Version ^4.2
monolog/monolog Version ^3.5
symfony/console Version ^7
symfony/filesystem Version ^7
symfony/finder Version ^7
symfony/monolog-bridge Version ^7
symfony/process Version ^7