README
¶
Rackjobber
Rackjobber is a CL-Tool written in Go, which automates versioning of Plugins and Themes for Shopware projects. Use the 'up' command to update and install all configured Plugins and Themes for your specified Shopware project
Installation
Refer to the release Page for archives or use Brew:
brew tap wdy/rackjobber https://github.com/worldiety/rackjobber
brew install wdy/rackjobber/rackjobber
rackjobber
Considering Themes used by Rackjobber:
To set a Theme shopware uses the namespace specified in the Theme.php, which is stored in [PluginName]/Resources/Themes/Frontend/[ThemeName]/Theme.php
Rackjobber is only able to set a Theme, when the corresponding rackspec.yaml specifies this namespace in the theme: section
If shopware does not display your theme correctly, consider the following possible solutions:
Does the Theme Manager in shopware recognize your chosen theme?
To check this, access the Backend of your Shopware store at [shopdomain]/backend/, and open Configuration -> Theme Manager.
If your chosen Theme is not listed here, rackjobber was not able to integrate it into shopware. Please check the following:
- Is your Theme listed in the
rackfile.yamlon your shopware server? - Is your Theme's
rackspec.yamlup to date, as well as the specified Git-URL in it?
shopware recognizes my Theme, but Rackjobber's up does not set it
Please check the following:
- Does the
rackfile.yamlon your shopware server contain multiple Themes? In this case, Rackjobber will set the latest one of the specified Themes. - Does your
rackspec.yaml's set Theme correspond to the Theme's namespace? To check this, navigate to therackspec.yamlof the version of your Theme, to be found atrackjobber/rackressources/repos/master/[ThemeName]/[ThemeVersion]/[ThemeName]_rackspec.yamland look for thethemesection inside this yaml, looking something like this:
theme: TestTheme
Now, navigate to your Theme's Theme.php on your shopware Server, to be found at [PluginName]/Resources/Themes/Frontend/[ThemeName]/Theme.php
and look for the namespace section, looking something like this:
<?php
namespace Shopware\Themes\TestTheme;
use Shopware\Components\Form as Form;
Here, the Theme specified in the rackpec.yaml has to correspond to the last part of the Theme.php's namespace.
If it does not, please change the rackspec.yaml accordingly.
SSH Connection
Rackjobber uses the SSH protocoll to establish a secure connection to the shopware server.
It uses the public host key and the private rsa key at their default locations ~/.ssh/known_hosts and ~/.ssh/id_rsa
These keys have to be setup manually. Information on how to setup an initial SSH connection can be found here.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package fileutil includes functions to read, write and work with files and directories
|
Package fileutil includes functions to read, write and work with files and directories |
|
Package gitutil includes functions to connect to and manage GIT-based Repositories
|
Package gitutil includes functions to connect to and manage GIT-based Repositories |
|
Package rackcommands includes the commands the user may call, to be used by the cli.App
|
Package rackcommands includes the commands the user may call, to be used by the cli.App |
|
Package rackconfig includes the struct and functions to setup and retrieve information from the config
|
Package rackconfig includes the struct and functions to setup and retrieve information from the config |
|
Package rackfile includes structs and functions to setup and retrieve information from rackfile.yamls
|
Package rackfile includes structs and functions to setup and retrieve information from rackfile.yamls |
|
Package rackinput includes functions for managing user input
|
Package rackinput includes functions for managing user input |
|
Package rackplugin includes the struct and functions to setup and retrieve information from the plugins rackspec
|
Package rackplugin includes the struct and functions to setup and retrieve information from the plugins rackspec |
|
Package rackpluginhashes includes structs and functions
|
Package rackpluginhashes includes structs and functions |
|
Package racksetup includes functions to setup the master Repository
|
Package racksetup includes functions to setup the master Repository |
|
Package rackshop includes the struct and functions to manage rackshops used in the rackshopstore
|
Package rackshop includes the struct and functions to manage rackshops used in the rackshopstore |
|
Package rackshopstore includes structs and operations to setup and manage shops for rackjobber to work on
|
Package rackshopstore includes structs and operations to setup and manage shops for rackjobber to work on |
|
Package rackspec includes the struct and functions to setup and manage the rackspec.yaml
|
Package rackspec includes the struct and functions to setup and manage the rackspec.yaml |
|
Package rackssh includes functions to establish and use a ssh connection to a server running shopware
|
Package rackssh includes functions to establish and use a ssh connection to a server running shopware |
|
Package rackup includes the implementation of the Up Command to update Plugins on a given shop
|
Package rackup includes the implementation of the Up Command to update Plugins on a given shop |
|
Package repository includes functions to manage GIT-based repositories
|
Package repository includes functions to manage GIT-based repositories |