Although for me it looks clear and straightforward, for some it may not be the case, so I decided to add a brief document explaining it. It should show up in Read The Docs here: http://jenkinsploneorg.readthedocs.org/en/latest/run-pull-request-jobs.html
If Read The Docs still hasn’t catch up the source in GitHub is easily readable as well: https://github.com/plone/jenkins.plone.org/blob/master/docs/source/run-pull-request-jobs.rst
Bonus point: I made my first screencast demoing it! Watch it in all its glory.
0 to 1k
Yesterday marked the day that Jenkins Job “Pull Request 5.0” hit the 1000 job (right now running the 1016!).
It’s been a long journey to get it to its current status but IMHO since the introduction of it our three main Jenkins Jobs for both 4.3 and 5.0 have been far more stable.
Thanks to everyone that reported feedback and is using it!
100k to 0?
Jenkins is not only about tests, code analysis and all other kind of jobs are running on http://jenkins.plone.org. Two of the latest additions are:
- per package code analysis jobs that report back to github: packages can opt-in and are checked with flake8 and other tools
- a global code analysis job: exactly the same as the per package jobs mentioned on the previous point, but running code analysis on ALL packages
The 100k is the flake8 error count for the global job, will we be able to bring that down to zero? :-)
Side note: Zope2 and CMFCore are the two (by far) with more code analysis errors, some other packages are probably going to be deprecated so there is no need to clean up them.
Best of both things?
Anyone (you!?) can grab a package clean it up, and run a pull request job to ensure nothing is broken after the clean up and happily merge it.
I wrote a small guide with a step by step instructions on how to cleanup a package code so that it follows our Plone style guide.
To add sugar on top, the packages that are already monitored for it, point you to that same guide, see it in action.
On my talk at the Plone Conference 2015 (slides, talk notes from Maurits) one of my points was that a written style guide is worth nothing if you can not check/enforce it.
Who cares what a style guide says regarding indentation, dependencies, string quoting, docstrings, handling i18n, etc etc if then one can freely commit changes that go against the said style guide?
Fortunately in Python we already have pep8 (the tool) and flake8 (with its great plugin ecosystem). To top it off, on Plone we already have plone.recipie.codeanalysis. We have the tools.
Talk is cheap
I’ve been putting as much effort and free time as I could to make that happen.
plone.recipe.codeanalysis has been improved, flake8 plugins have been written, and finally during this last Alpine City Strategic Sprint 2016 I could implement the missing piece: report back to the users (see an example)!
The script is fairly simple:
wget https://raw.githubusercontent.com/plone/buildout.coredev/5.0/bootstrap.py -O bootstrap.py
wget https://raw.githubusercontent.com/plone/buildout.coredev/5.0/experimental/qa.cfg -O qa.cfg
wget https://raw.githubusercontent.com/plone/plone.recipe.codeanalysis/master/.isort.cfg -O .isort.cfg
python bootstrap.py -c qa.cfg
bin/buildout -c qa.cfg
Run the above on any Plone distribution and see the output collected on parts/code-analysis/flake8.log
Currently only a few packages are checked, but cleanup tasks can start on any Plone package as of now. Be sure to ask for a job that will check that the package remains clean as soon as your cleanup changes are merged!
This past five days I had the pleasure the be part on the last Plone sprint: Alpine City Strategic Sprint 2016, what a blast!
In the following days, the amazing never running out of steam, Jens will report back to the community. A partial/preview report already exists for the impatient ones (disclaimer: I made it, so there’s probably quite a few things missing).
Below I will make a summary of what I achieved thanks to being part of the sprint.
- bring back node4 on Jenkins: meaning that we can run more jobs at the same time, really handy for a sprint or at release time/high activity!
- quickly update (totally untested, so dragons ahead) ZODB, Zope, ZTK and CMF jenkins jobs, now they are bundled together in a tab. Pointers on how to make them reliable/improve them highly appreciated, submit tickets for it so we can keep track of them
- create jenkins jobs for PLIPs being worked on during the sprint. In retrospect they took me less than 5 minutes of work and they proved to be extremely helpful. Pro tip: whenever working on a new PLIP ask for a jenkins job!
- create more jenkins jobs for checking, and reporting back, code analysis on distributions (more about it on a follow-up post)
Fortunately all the above took less than one or two hours, my main task during the sprint was, together with Maik, bring collective.indexing in Plone core without having to add yet another package. Please read the PLIP description, linked above, to know the scope of it.
As of now we are down to one single test failure! We are highly appreciated on creative ways to solve that last one…
Not only work
A sprint is way more than just sitting in front of a laptop and coding!
Lots of interesting discussions where held, we had lots of fun, we did some sightseeing and enjoyed being together.
And after that I can only say that Plone’s future is brighter than ever has been!
As a personal pet peeve, we finally agreed (?) on how to sort imports! :-)
Last words go to Jens and Christine for taking so much care on preparing everything and being so open and helpful at any time, thanks!
I’m glad you asked, because there’s plenty of them, for example these ones:
Move core packages’ translations to plone.app.locales
There a step by step tutorial on the first message and plenty of packages to choose from.
World Plone Office Day is 3 weeks away only so, whether you are hosting one office day or you are thinking of to attend it, be sure to get a list of easy tasks to do for newcomers.
It probably happened to you, dear reader, every now an then: the new feature you are working on has changes across more than one git repository, so how can this be tested to make sure nothing is broken before merging those nth separate pull requests?
That’s what #126 was about and finally, thanks to WPOD and the company I work for to allowing me take part of it, it’s finally fixed.
Let us know if it does not work as expected!
Now with Mockup he have the other side of the coin as well: we can not only check how the code integrates within Plone but we can also check its logic with fast unittests.
There’s already Travis integration for Mockup and Mockup-core (a building block for Mockup), but as Plone is using Jenkins it makes a lot of sense to run them there as well.
So, how that’s done? I’m glad you ask, exactly like this:
- Add Nodejs on Jenkins nodes (plone.jenkins_node)
- Configure Jenkins so that tests will find where Nodejs is (plone.jenkins_server)
- Add a make target for the new Grunt configuration (mockup)
- Create a Jenkins job that runs it (jenkins.plone.org)
All the code is there, the last three pull requests are pending to be merged.
P.D: remember that tomorrow is WPOD!
This Friday Mai 29th we are celebrating the 2nd edition of WPOD!
Look around your city, meet with friends, make new ones and contribute to Plone!
As usual IRC will be full of contributors willing to help smooth your path into Plone, so don’t be shy and ask ;)
For Berliners: we will meet again at der Freitag offices, please RSVP at meetup.
See you there/in IRC!
Did you ever got tired waiting a repository (managed by mr.developer) to be cloned?
Wait no more! mr.developer 1.32 comes with two new options to make your life easier:
- a global git-clone-depth option that allows to fetch only the amount of history specified on this option (i.e. git-clone-depth = 1 for only one single commit)
- a per-source depth option that allows to specify the same as git-clone-depth but only for that specific source
What’s the benefit of this? See it for yourself:
git clone https://github.com/plone/buildout.coredev.git test-full
du -sh test-full
git clone https://github.com/plone/buildout.coredev.git --depth=1 test-shallow
du -sh test-shallow
That’s a 24x saving.
So think about your CI environments where they are downloading over and over the whole repository information while you only care about the very last changes.
Think about some remote environments (mobile connection while you are on a train?)
Update: it seems that is completely broken, sorry for that, working on a fix.
Update 2: mr.developer 1.33 released, thanks @fschulze for the new release!