Ticket #421 (closed defect: fixed)

Opened 4 years ago

Last modified 4 years ago

Triggerable example code is missing an assignment

Reported by: jkugler Owned by: ashcrow
Priority: major Milestone: 0.7.10
Version: 0.7.9 Keywords:
Cc:

Description

In http://buildbot.net/repos/release/docs/buildbot.html#Triggerable-Scheduler there is this example (abridged to just show "bug"):

     # on checkin, make a tarball, build it, and test it
     checkin_factory = factory.BuildFactory()
     f.addStep(trigger.Trigger('mktarball', schedulers=['mktarball'],
                                            waitForFinish=True)
     f.addStep(trigger.Trigger('build', schedulers=['build-all-platforms'],
                                        waitForFinish=True)
     f.addStep(trigger.Trigger('test', schedulers=['distributed-test'],
                                       waitForFinish=True)
     
     # and every night, make a tarball, build it, and package it
     nightly_factory = factory.BuildFactory()
     f.addStep(trigger.Trigger('mktarball', schedulers=['mktarball'],
                                            waitForFinish=True)
     f.addStep(trigger.Trigger('build', schedulers=['build-all-platforms'],
                                        waitForFinish=True)
     f.addStep(trigger.Trigger('package', schedulers=['package-all-platforms'],
                                          waitForFinish=True)

Either there needs to be a f = foo_factory assignment, or there needs to be explanation where the f object comes from.

Change History

comment:1 Changed 4 years ago by ashcrow

  • Owner set to ashcrow
  • Status changed from new to assigned

I think f should be checkin_factory. Making that change.

comment:2 Changed 4 years ago by ashcrow

Here is my proposed change:

diff --git a/docs/buildbot.texinfo b/docs/buildbot.texinfo
index cfb5cfd..5f9d17d 100644
--- a/docs/buildbot.texinfo
+++ b/docs/buildbot.texinfo
@@ -2649,6 +2649,7 @@ Here is a fully-worked example:
 
 @example
 from buildbot import scheduler
+from buildbot.process import factory
 from buildbot.steps import trigger
 
 checkin = scheduler.Scheduler(name="checkin",
@@ -2673,20 +2674,20 @@ c['schedulers'] = [checkin, nightly, build, test, package]
 
 # on checkin, make a tarball, build it, and test it
 checkin_factory = factory.BuildFactory()
-f.addStep(trigger.Trigger('mktarball', schedulers=['mktarball'],
+checkin_factory.addStep(trigger.Trigger('mktarball', schedulers=['mktarball'],
                                        waitForFinish=True)
-f.addStep(trigger.Trigger('build', schedulers=['build-all-platforms'],
+checkin_factory.addStep(trigger.Trigger('build', schedulers=['build-all-platforms'],
                                    waitForFinish=True)
-f.addStep(trigger.Trigger('test', schedulers=['distributed-test'],
+checkin_factory.addStep(trigger.Trigger('test', schedulers=['distributed-test'],
                                   waitForFinish=True)
 
 # and every night, make a tarball, build it, and package it
 nightly_factory = factory.BuildFactory()
-f.addStep(trigger.Trigger('mktarball', schedulers=['mktarball'],
+checkin_factory.addStep(trigger.Trigger('mktarball', schedulers=['mktarball'],
                                        waitForFinish=True)
-f.addStep(trigger.Trigger('build', schedulers=['build-all-platforms'],
+checkin_factory.addStep(trigger.Trigger('build', schedulers=['build-all-platforms'],
                                    waitForFinish=True)
-f.addStep(trigger.Trigger('package', schedulers=['package-all-platforms'],
+checkin_factory.addStep(trigger.Trigger('package', schedulers=['package-all-platforms'],
                                      waitForFinish=True)
 @end example
 

comment:3 Changed 4 years ago by ashcrow

comment:4 Changed 4 years ago by dustin

  • Status changed from assigned to closed
  • Resolution set to fixed

thanks! The last three should be nightly_factory. I fixed it :)

Note: See TracTickets for help on using tickets.