Project

General

Profile

Bug #1731

document jenkins configuration and set up means to track changes

Added by Szilárd Páll over 4 years ago. Updated about 2 years ago.

Status:
In Progress
Priority:
Normal
Assignee:
-
Category:
-
Target version:
-
Affected version - extra info:
Affected version:
Close

Description

[ RFC ]

Both user-/developer-facing and internal documentation is lacking. Changes and tweaks are made regularly without documenting them. This can and did lead to inconsistencies (CUDA 6.5 configs went missing, AVX2 added to only release 5.0 not master, etc.), clutter (nobody knows which plugins is used and which one is not), and in general a slowly increasing level of disorganization.

I propose:

Related issues

Related to Support Platforms - Feature #1601: use Git for Jenkins ConfigNew09/21/2014

History

#1 Updated by Roland Schulz over 4 years ago

#2 Updated by Gerrit Code Review Bot about 4 years ago

Gerrit received a related patchset '1' for Issue #1731.
Uploader: Teemu Murtola ()
Change-Id: I87e180d12a77c692ac4594b6c062fb6ca150aa5d
Gerrit URL: https://gerrit.gromacs.org/4694

#3 Updated by Teemu Murtola about 4 years ago

The linked change (and changes leading up to that) provide my view on the direction where we should be taking this from a developer perspective. It does not contribute much to the Jenkins internal documentation (although I'm planning to update the description of the jobs affected, once the changes in Gerrit are merged).

#4 Updated by Teemu Murtola about 4 years ago

Once https://gerrit.gromacs.org/#/c/4695/ and its predecessors is merged (and I've had time to update the project descriptions in Jenkins after that), feedback is welcome on the developer-facing side of the documentation and uncrustify jobs, both on the documentation and on the actual behavior. I put a bit of effort to making those more user-/developer-friendly.

#5 Updated by Teemu Murtola over 3 years ago

Another batch of documentation updates are in https://gerrit.gromacs.org/5839 and https://gerrit.gromacs.org/5838 (and their predecessors). For now, you will need to build the documentation locally (with Sphinx 1.3+, with the webpage-sphinx target). I did not get any feedback for the previous set of changes; I'd be delighted to get some now...

Some Jenkins configuration is still in Jenkins only, but a significant fraction is now under admin/builds/ in the gromacs repo, and in the releng repo. This provides much better change tracking and possibility to discuss changes in Gerrot before they go into production. In particular, the configuration matrix is in admin/builds/pre-submit-matrix.txt.

#6 Updated by Gerrit Code Review Bot over 3 years ago

Gerrit received a related patchset '3' for Issue #1731.
Uploader: Teemu Murtola ()
Change-Id: If71cb725f966ea5acd72585fb3a1aa65e1a269ff
Gerrit URL: https://gerrit.gromacs.org/5839

#7 Updated by Szilárd Páll about 2 years ago

  • Status changed from New to In Progress

Szilárd Páll wrote:

I think we've gone quite far in both aspects. Is there anything that we should summarize here -- in particular remaining TODOs that we could put perhaps into a new, separate issue?

  • keeping track of the changes in jenkins (changelog?), it could be useful to keep some of the on-site non-versioned scripts in a repository
    that should always keep everybody informed about

I'd consider this partially resolved, AFAIU from Stefan, we are tracking Jenkins changes in an internal git repo but possibly, but I can't find docs of how this works and how can changes be tracked, rolled back, etc. Am I overlooking something?

Also available in: Atom PDF