Upgrade HuPKit

Upgrade to v1.4.0-BETA1

Using global configuration for repositories is now deprecated and will be removed in v2.0. Use repository local configuration instead.

Use the init-config command for each repository to import the global configuration, then manually remove the repository in the global configuration.

Upgrade to v1.3.0-BETA2

Storing the branch-alias in Git configuration is now deprecated and will be removed in v2.0. Either add the extra.branch-alias.dev-main in composer.json, or add "branches_alias.main" to the repository local configuration:

1
2
3
4
5
6
7
8
 
return [
    // ...

    'branches_alias' => [
        'main' => '1.0',
    ],

];

Upgrade to v1.2.0-BETA6

The pre/post release hook scripts are now expected to be stored in the _hubkit configuration branch.

Using the ".hubkit" directory at the root of the repository is still supported, but will no longer work in HuPKit v2.0.

Caution

Hooks are loaded from a temporary location outside of the repository, use the __DIR__ constant to load files from the the temp-location, use $container['current_dir'] to get the actual location to the project repository.

The services already use the correct current location (the repository root).

For example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
<?php

// pre-release.php (in the "_hubkit" branch)

declare(strict_types=1);

use Psr\Container\ContainerInterface as Container;
use Rollerworks\Component\Version\Version;

return function (Container $container, Version $version, string $branch, ?string $releaseTitle, string $changelog) {

    $container->get('logger')->debug('Working at: ' . $container['current_dir']);
    $container->get('logger')->info('Updating composer branch-alias');

    $container->get('process')->mustRun(['composer', 'config', 'extra.branch-alias.dev-'.$branch, sprintf('%d.%d-dev', $version->major, $version->minor)]);

    /** @var \HubKit\Service\Git\GitBranch $gitBranch */
    $gitBranch = $container->get('git.branch');

    if ($gitBranch->isWorkingTreeReady()) {
        return; // Nothing to, composer is already up-to-date
    }

    $gitBranch->add('composer.json');
    $gitBranch->commit('Update composer branch-alias');

    /** @var \HubKit\Service\Git $git */
    $git = $container->get('git.branch');
    $git->pushToRemote('upstream', $branch);
};

Upgrade to v1.2.0-BETA4

The configuration format was changed to allow for more advanced features, change the schema_version to 2 and upgrade to the new structure.

Note

The old configuration format still works (until the next major release of HuPKit) but will give a warning.

For config.php the new structure is as follows, see the Configuration chapter for all options.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
-    'schema_version' => 1,
+    'schema_version' => 2,

-//    'repos' => [
-//        'github.com' => [
-//            'park-manager/park-manager' => [
-//                'sync-tags' => true,
-//                'split' => [
-//                    'src/Bundle/CoreBundle' => 'git@github.com:park-manager/core-bundle.git',
-//                    'src/Bundle/UserBundle' => 'git@github.com:park-manager/user-bundle.git',
-//                    'doc' => ['git@github.com:park-manager/doc.git', 'sync-tags' => false],
-//                ],
-//            ],
-//        ],
-//    ],
+
+    'repositories' => [
+        'github.com' => [
+            'park-manager/park-manager' => [
+                'branches' => [
+                    ':default' => [
+                        'sync-tags' => true,
+                        'split' => [
+                            'src/Module/CoreModule' => 'git@github.com:hubkit-sandbox/core-module.git',
+                            'src/Module/WebhostingModule' => 'git@github.com:hubkit-sandbox/webhosting-module.git',
+                            'docs' => ['url' => 'git@github.com:park-manager/doc.git', 'sync-tags' => false],
+                        ],
+                    ],
+                    '1.0' => false, // Disabled
+                    '2.x' => [
+                        'upmerge' => false,
+                        // Split's is inherited and merged from ':default'
+                        'split' => [
+                            'src/Module/DomainRegModule' => 'git@github.com:hubkit-sandbox/webhosting-module.git',
+                        ],
+                    ],
+                    '3.x' => [
+                        'sync-tags' => null, // Inherit from the root configuration.
+                        'split' => [
+                            'src/Module/WebhostingModule' => false,
+                            'src/Module/DomainRegModule' => 'git@github.com:hubkit-sandbox/webhosting-module.git',
+                        ],
+                    ],
+                    '4.1' => [
+                        'ignore-default' => true, // Nothing is inherited from ':default'
+                        'sync-tags' => false,
+                        'src/Bundle/CoreBundle' => 'git@github.com:hubkit-sandbox/core-module.git',
+                        'src/Bundle/WebhostingBundle' => 'git@github.com:hubkit-sandbox/webhosting-module.git',
+                        'docs' => ['url' => 'git@github.com:park-manager/doc.git', 'sync-tags' => false],
+                    ],
+                ],
+            ],
+        ],
+    ],