Update branching option to branch from another branch. #4531

adbridge · 2017-06-12T17:03:20Z

Previously if updating a branch in the ARMmbed version of an example
repo, the branch would be created initially from master. This update
allows the new branch to be created from any pre-existing branch.
This update also moves the branch / fork / tag configuration data to the
json config file. It thus simplifies the command line.
-b on its own now indicates use the branch information in the config
-f on its own now indicates use the fork information in the config

Previously if updating a branch in the ARMmbed version of an example repo, the branch would be created initially from master. This update allows the new branch to be created by any pre-existing branch. This update also moves the branch / fork / tag configuration data to the json config file. It thus simplifies the command line. -b on its own now indicates use the branch information in the config -f on its own now indicates use the fork information in the config

theotherjimmy · 2017-06-13T14:52:53Z

lol. love the title

theotherjimmy

Looks fine. Nits, questions and future work below.

theotherjimmy · 2017-06-13T14:57:51Z

tools/test/examples/update.py

+
+                # Push new branch upstream
+                cmd = ['git', 'push', '-u', 'origin', dst]
+                return_code = run_cmd(cmd)


If all of these commands share error behavior, could we have a construct like:

for cmd in [['git', 'checkout', src], ['git', 'checkout', '-b', dst], ['git', 'push', '-u', 'origin', dst]]: return_code = run_cmd(cmd) if return_code: break else: update_log.error("Failed to prepare branch: %s", dst)

Not sure that does what you think? If each command ran successfully then there would be no break , the loop would terminate and the 'else' clause run...
From python help:
"For loops also have an else clause which most of us are unfamiliar with. The else clause executes when the loop completes normally. This means that the loop did not encounter any break. ". Could be tweaked to replace the 'else' clause with an additional check of return_code though

Eh, fine use if return_code.

Actually, I was thinking of:

for cmd in [['git', 'checkout', src], ['git', 'checkout', '-b', dst], ['git', 'push', '-u', 'origin', dst]]: return_code = run_cmd(cmd) if return_code: break else: return True update_log.error("Failed to prepare branch: %s", dst) return False

OH, we can do better:

for cmd in [['git', 'checkout', src], ['git', 'checkout', '-b', dst], ['git', 'push', '-u', 'origin', dst]]: if run_cmd(cmd): update_log.error("Failed to prepare branch: %s", dst) return False return True

Have improved it further, this function doesn't really need to have it's own separate error so can actually just use run_cmd(cmd, exit_on_failure=True). It wasn't even checking the return from prepare_fork() or prepare_branch() anyway!

Nice! so:

for cmd in [['git', 'checkout', src], ['git', 'checkout', '-b', dst], ['git', 'push', '-u', 'origin', dst]]: run_cmd(cmd, exit_on_failure=True)

theotherjimmy · 2017-06-13T14:59:38Z

tools/test/examples/update.py

+
+                    body = "Please test this PR.\n"
+                    body += "If successful then merge, otherwise provide a known issue.\n"
+                    body += "Once you get notification of the release being made public then tag Master with " + tag


Could we make a note to replace all of these bodies with jinja templates? I think it would ease maintenance.

Might be overkill for just the one case in this file ?

Do you really think this is going to be the only case where we emit a blob of text? I think there may be more when we extend this script later.

theotherjimmy · 2017-06-13T15:01:50Z

tools/test/examples/update.py

-    exclusive.add_argument('-U', '--github_user', help="GitHub user for forked repos, mutually exclusive to branch option")
-    exclusive.add_argument('-b', '--branch', help="Branch to be updated, mutually exclusive to user option")
+    exclusive.add_argument('-f', '--fork', help="Update a fork", action='store_true')
+    exclusive.add_argument('-b', '--branch', help="Update a branch", action='store_true')


We could also do sumcommands here. Invocation would be python update.py fork vs python update.py -f

Not sure i see what the benefit here is ?

in unix tradition, things starting with "-" are flags that are optional. before you use make.py, bulid.py or project.py as an example, remember that I did not write that bit, and it can't be changed.

mmm but by that argument you would have something like :
update.py token 12eedf34455gggg
Which doesn't feel right to me at all -T 12eedf34455gggg is much more intuitive, but it is still a compulsory argument.. ?

Not quite. Do you need the github token to work correctly? Could you do a "dry run" without it?

@adbridge For things that are booleans/enums, you end up with subcommands, for things that are required and not booleans/enums, you end up with positional arguments. That's the unix tradition that I'm familiar with

You also need the tag in there :)
I could live with having 'branch' or 'fork' as mutually exclusive sub-commands , think the others will stay as they are.

@adbridge This is really a style issue, so it comes down to your preference. I think that you will likely be the most common user of this script.

Eventually the CI will be the user , but it would ultimately be nice to have a consistent approach across all our tools ...

Well, computers aren't really the consumers. I'm expecting that you will write the script or job that calls this script in CI. That would make you the consumer.

config file

adbridge · 2017-06-21T10:53:59Z

@theotherjimmy ok I think that's the last of the comments, can you just double check the last couple of commits? Thanks

theotherjimmy · 2017-06-21T14:09:27Z

tools/test/examples/update.py

@@ -475,13 +481,15 @@ def create_work_directory(path):
    failures = []
    successes = []
    results = {}
+    template = dirname(abspath(__file__))


I don't think this is the template. Maybe it's the template directory?

yeah template directory, seemed like too long a name though ! Could have gone with tmpl_dir or similar I guess .

¯\_(ツ)_/¯

theotherjimmy

Looks great!

theotherjimmy · 2017-06-26T15:25:16Z

@adbridge Does this need to be run through CI?

adbridge · 2017-06-27T10:13:46Z

@theotherjimmy We can run through ci if we want but this script doesn't get tested by anything there...

theotherjimmy · 2017-06-27T16:19:05Z

Cool. Let's merge when Cam-CI gets back to us.

0xc0170 · 2017-06-28T12:00:14Z

retest uvisor

adbridge · 2017-07-05T08:05:24Z

@theotherjimmy This was merged without a release label! Should really have gone to 5.5.2

0xc0170 requested a review from theotherjimmy June 13, 2017 09:35

0xc0170 added the needs: review label Jun 13, 2017

theotherjimmy approved these changes Jun 13, 2017

View reviewed changes

adbridge added 2 commits June 13, 2017 17:31

Remove remaining use of args.tag and replace with tag obtained from

b4ac0d0

config file

Added template file for PR commit message plus minor review changes

d1f3eb6

theotherjimmy reviewed Jun 21, 2017

View reviewed changes

theotherjimmy approved these changes Jun 21, 2017

View reviewed changes

adbridge added ready for merge and removed needs: review labels Jun 22, 2017

theotherjimmy merged commit 18b1cb6 into ARMmbed:master Jun 29, 2017

theotherjimmy removed the ready for merge label Jun 29, 2017

adbridge added the release-version: 5.5.3 label Jul 5, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update branching option to branch from another branch. #4531

Update branching option to branch from another branch. #4531

adbridge commented Jun 12, 2017 •

edited

Loading

theotherjimmy commented Jun 13, 2017

theotherjimmy left a comment

theotherjimmy Jun 13, 2017

adbridge Jun 13, 2017 •

edited

Loading

theotherjimmy Jun 13, 2017

theotherjimmy Jun 13, 2017

theotherjimmy Jun 13, 2017 •

edited

Loading

adbridge Jun 15, 2017

theotherjimmy Jun 15, 2017

theotherjimmy Jun 13, 2017

adbridge Jun 13, 2017

theotherjimmy Jun 13, 2017

theotherjimmy Jun 13, 2017

adbridge Jun 13, 2017

theotherjimmy Jun 13, 2017

adbridge Jun 14, 2017

theotherjimmy Jun 14, 2017

theotherjimmy Jun 14, 2017

adbridge Jun 14, 2017 •

edited

Loading

theotherjimmy Jun 14, 2017

adbridge Jun 15, 2017

theotherjimmy Jun 15, 2017

adbridge commented Jun 21, 2017

theotherjimmy Jun 21, 2017

adbridge Jun 22, 2017

theotherjimmy Jun 22, 2017

theotherjimmy left a comment

theotherjimmy commented Jun 26, 2017

adbridge commented Jun 27, 2017 •

edited

Loading

theotherjimmy commented Jun 27, 2017

0xc0170 commented Jun 28, 2017

adbridge commented Jul 5, 2017 •

edited

Loading

Update branching option to branch from another branch. #4531

Update branching option to branch from another branch. #4531

Conversation

adbridge commented Jun 12, 2017 • edited Loading

theotherjimmy commented Jun 13, 2017

theotherjimmy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adbridge Jun 13, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

theotherjimmy Jun 13, 2017 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adbridge Jun 14, 2017 • edited Loading

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

adbridge commented Jun 21, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

theotherjimmy left a comment

Choose a reason for hiding this comment

theotherjimmy commented Jun 26, 2017

adbridge commented Jun 27, 2017 • edited Loading

theotherjimmy commented Jun 27, 2017

0xc0170 commented Jun 28, 2017

adbridge commented Jul 5, 2017 • edited Loading

adbridge commented Jun 12, 2017 •

edited

Loading

adbridge Jun 13, 2017 •

edited

Loading

theotherjimmy Jun 13, 2017 •

edited

Loading

adbridge Jun 14, 2017 •

edited

Loading

adbridge commented Jun 27, 2017 •

edited

Loading

adbridge commented Jul 5, 2017 •

edited

Loading