Default branch to `main` instead of `master` #172

RSickenberg · 2022-03-30T12:43:40Z

Allow me to fix this:
#170

Note I couldn't run the PHPUnit in a clean env like the CI.

Greetings to everyone in Lausanne 👋🏼 💚

DIDN'T RAN PHPUNIT (YET)

jeanmonod · 2022-03-30T14:55:35Z

Thanks a lot for this PR 👍

There is still an issue with the tests because they rely on a small embedded Git repo: https://github.com/liip/RMT/blob/master/test/Liip/RMT/Tests/Unit/VCS/gitRepo.zip where the branch is still named master.

This is showing us, that changing the main branch name is a breaking change for existing RMT install (existing projects that are still using the master naming). We should find a way to make this configurable on the config. So we can ask users to add this config into rmt.yml if there are in this situation. Do you want to try to do this?

I imagine something like this:

vcs: 
  name: git
  main-branch: master

To locally run the tests, there is a documentation here: https://github.com/liip/RMT/blob/master/README.md#tests

Thanks again for your efforts!

Sorry for this, didn't knew the existence of this file

RSickenberg · 2022-03-30T16:05:46Z

Thanks, @jeanmonod for the input! Like I wrote on cd3b975, I didn't know about this small repo before so this answers the question I had about this.

I indeed followed the documentation, but my tests are differing from the CI, I have ~6/7 failures VS 2 (one should be fixed now) on the CI.
The issue must be due to the fact I'm running this on my machine with PHP 8.1.4.

I would love to contribute more on a migration script, let me some time to do so 🙂

jeanmonod · 2022-03-30T16:32:34Z

@RSickenberg Changing the repo is an option to fix the tests. But you are still leaving alone all the users working with a master branch. For backward compatibility reason, we need a way to configure the main branch name in the config.
If you can do it, that's great, otherwise I will try to find someone on Lausanne to do it :)

RSickenberg · 2022-03-31T08:30:35Z

@jeanmonod Sure, I will find a way to take care of that!

RSickenberg · 2022-03-31T18:35:59Z

Hello @jeanmonod, could you run the tests?

What do you think of the current approach?

jeanmonod

Thanks a lot @RSickenberg

I just did a first review! At this end, it's not an easy-pick at all. Sorry for that.

Can I ask you one more thing? To keep master branch name into the functional tests. Like this: 1) It's testing to use a different branch than main. So it's ensuring backward compat 2) We don't need to change the embedded Git repo?

jeanmonod · 2022-03-31T19:51:22Z

.gitignore

@@ -5,3 +5,4 @@ cache.properties
 bin
 !bin/UpdateApplicationVersionCurrentVersion.php
 .phpunit.result.cache
+.idea/


Please keep this for your local git ignore

jeanmonod · 2022-03-31T19:52:07Z

README.md

@@ -6,15 +6,15 @@ RMT - Release Management Tool
 [![Total Downloads](https://poser.pugx.org/liip/RMT/d/total.png)](https://packagist.org/packages/liip/RMT)
 [![License](https://poser.pugx.org/liip/rmt/license.svg)](https://packagist.org/packages/liip/rmt)

-RMT is a handy tool to help releasing new versions of your software. You can define the type
+RMT is a handy tool to help releasing a new versions of your software. You can define the type


new versionS. It was just before

jeanmonod · 2022-03-31T19:53:17Z

README.md

@@ -123,12 +123,12 @@ RMT also support JSON configs, but we recommend using YAML.
 ### Branch specific config

 Sometimes you want to use a different release strategy according to the VCS branch, e.g. you want to add CHANGELOG entries only in the `master` branch. To do so, you have to place your default config into a root element named `_default`, then you can override parts of this default config for the


One missing master here

jeanmonod · 2022-03-31T20:01:09Z

src/Liip/RMT/Command/InitCommand.php

+                'choices' => array('main', 'master'),
+                'choices_shortcuts' => array('m' => 'main', 'mst' => 'master'),
+                'default' => 'main',
+            )),


I don't like so much this question. If the user is saying none at the previous question, then it makes no sense to ask him a branch name.
But I have to admit that in most case users will use Git. Maybe allow also a choice n=>none. And adjust a bit the question:

The default branch you want to use (select none if you are not using a VCS system)

jeanmonod · 2022-03-31T20:04:01Z

src/Liip/RMT/Config/templates/default-vcs-config.yml.tmpl

@@ -24,8 +26,8 @@ _default:
            ask-confirmation: true

 # BRANCH SPECIFIC CONFIG
-#  On master, we override the general config
-master:
+#  On main, we override the general config


Please also use the %%main-branch%% in this comment

src/Liip/RMT/Information/InformationCollector.php

jeanmonod · 2022-03-31T20:05:25Z

test/Liip/RMT/Tests/Functional/GitTest.php

@@ -19,17 +19,35 @@ public function testInitialVersion(): void
        $this->createConfig('simple', 'vcs-tag', array('vcs' => 'git'));
        exec('./RMT release -n --confirm-first');
        exec('git tag', $tags);
-//        $this->manualDebug();


Please keep all this $this->manualDebug();, they are very usefully to debug

jeanmonod · 2022-03-31T20:06:47Z

test/Liip/RMT/Tests/Functional/GitTest.php

+        $this->initGit();
+        $this->createConfig('simple', 'vcs-tag', ['vcs' => 'git']);
+        exec('git branch --show-current', $branch);
+        self::assertEquals('main', $branch[0]);


What are you testing here? To me this is not testing RMT...

jeanmonod · 2022-03-31T20:09:27Z

test/Liip/RMT/Tests/Functional/GitTest.php

+        self::assertEquals('master', $branch[0]);
+        exec('./RMT release -n --confirm-first');
+        exec('git tag', $tags);
+        self::assertEquals('1', $tags[0]);


Same here, I'm not really sure what you are testing. How could this test fail?

jeanmonod · 2022-03-31T20:14:00Z

.rmt.yml

-vcs: git
+vcs:
+  name: git
+  main-branch: main


Let's do one thing at a time. Let's first merge this PR and then after this, I will change the main branch name of this repo. So please set master here for now

… functionnal tests

RSickenberg · 2022-04-21T07:54:31Z

Hey @jeanmonod, can you run the tests, please? I saw I checked your comments so you might want to look at it :)

Regards

jeanmonod · 2022-05-05T09:01:55Z

Hi @RSickenberg,
Sorry for my long silence, but I was off for the past 15 days. I long but very resourcing break :)
I will take a look at your lasted commit as soon as possible

RSickenberg · 2022-05-05T09:20:11Z

Hello @jeanmonod, no worries! Hope this was a good break 🤗 !

Sure, let me know if you need anything.

RSickenberg added 2 commits March 30, 2022 14:41

feat(default_branch): refactored the default branch from master to main

a31353f

DIDN'T RAN PHPUNIT (YET)

docs(readme): removed the remaining master

cde4445

RSickenberg marked this pull request as ready for review March 30, 2022 12:55

RSickenberg added 2 commits March 30, 2022 18:00

test(zip_archive): changed the zip archive branch from master to main

cd3b975

Sorry for this, didn't knew the existence of this file

refactor(zip_archive): Removed master branch from the archive

b39f1b1

RSickenberg added 4 commits March 31, 2022 19:45

WIP, please discard

9029b3c

WIP, please discard

e8ceda5

WIP, good state with the default branch config

65063a2

test(tests): wrote some tests

185d000

jeanmonod requested changes Mar 31, 2022

View reviewed changes

RSickenberg added 3 commits March 31, 2022 22:51

refactor(pr): apply preliminary pr corrections

82364c3

refactor(cleanup): removed test-suite un-usefull + keep master on the…

86e4ce8

… functionnal tests

revert(gitrepo): revert the gitRepo with the version present in master

8d5c751

RSickenberg requested a review from jeanmonod April 21, 2022 07:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Default branch to `main` instead of `master` #172

Default branch to `main` instead of `master` #172

RSickenberg commented Mar 30, 2022 •

edited

Loading

jeanmonod commented Mar 30, 2022

RSickenberg commented Mar 30, 2022

jeanmonod commented Mar 30, 2022

RSickenberg commented Mar 31, 2022

RSickenberg commented Mar 31, 2022

jeanmonod left a comment

jeanmonod Mar 31, 2022

jeanmonod Mar 31, 2022

jeanmonod Mar 31, 2022

jeanmonod Mar 31, 2022

jeanmonod Mar 31, 2022

jeanmonod Mar 31, 2022

jeanmonod Mar 31, 2022

jeanmonod Mar 31, 2022

jeanmonod Mar 31, 2022

RSickenberg commented Apr 21, 2022

jeanmonod commented May 5, 2022

RSickenberg commented May 5, 2022

		@@ -123,12 +123,12 @@ RMT also support JSON configs, but we recommend using YAML.
		### Branch specific config

		Sometimes you want to use a different release strategy according to the VCS branch, e.g. you want to add CHANGELOG entries only in the `master` branch. To do so, you have to place your default config into a root element named `_default`, then you can override parts of this default config for the

Default branch to main instead of master #172

Are you sure you want to change the base?

Default branch to main instead of master #172

Conversation

RSickenberg commented Mar 30, 2022 • edited Loading

jeanmonod commented Mar 30, 2022

RSickenberg commented Mar 30, 2022

jeanmonod commented Mar 30, 2022

RSickenberg commented Mar 31, 2022

RSickenberg commented Mar 31, 2022

jeanmonod left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RSickenberg commented Apr 21, 2022

jeanmonod commented May 5, 2022

RSickenberg commented May 5, 2022

Default branch to `main` instead of `master` #172

Default branch to `main` instead of `master` #172

RSickenberg commented Mar 30, 2022 •

edited

Loading