Conventions for names of Jenkins jobs and job stages

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

Conventions for names of Jenkins jobs and job stages

Martin Schmude
Hello all,
at the department I am working at we operate a Jenkins with ~100 pipeline jobs.
The jobs have evolved over ~4 years without any conventions about job and stage names.
Today we have a mess. Related jobs cannot easily be recognized by name. The "logic" how a job is sectioned into stages is different between all jobs.

We want to clean up and establish naming conventions. Before thinking a lot myself an issue I want to become aware of how others solved it.
Maybe there are well established naming conventions out there that we don't know, but  could adopt easily. At jenkins.io I didn't land a hit.

Any hints? Thank you.

--
You received this message because you are subscribed to the Google Groups "Jenkins Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/c1a84e30-9d2f-41be-aeae-1404faf08b20n%40googlegroups.com.
Reply | Threaded
Open this post in threaded view
|

Re: Conventions for names of Jenkins jobs and job stages

Dirk Heinrichs-3
Am Mittwoch, den 27.01.2021, 08:53 -0800 schrieb 'Martin Schmude' via Jenkins Users:

Any hints?

While I won't tell you how to name your jobs, I'd like to point you at the folders plugin, which might help to organize them better.

HTH...

Dirk
-- 
Dirk Heinrichs
Senior Systems Engineer, Delivery Pipeline
OpenText ™ Discovery | Recommind
Phone: +49 2226 15966 18
Recommind GmbH, Von-Liebig-Straße 1, 53359 Rheinbach
Vertretungsberechtigte Geschäftsführer Gordon Davies, Madhu Ranganathan, Christian Waida, Registergericht Amtsgericht Bonn, Registernummer HRB 10646
This e-mail may contain confidential and/or privileged information. If you are not the intended recipient (or have received this e-mail in error) please notify the sender immediately and destroy this e-mail. Any unauthorized copying, disclosure or distribution of the material in this e-mail is strictly forbidden
Diese E-Mail enthält vertrauliche und/oder rechtlich geschützte Informationen. Wenn Sie nicht der richtige Adressat sind oder diese E-Mail irrtümlich erhalten haben, informieren Sie bitte sofort den Absender und vernichten Sie diese Mail. Das unerlaubte Kopieren sowie die unbefugte Weitergabe dieser Mail sind nicht gestattet.

--
You received this message because you are subscribed to the Google Groups "Jenkins Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/7048dc79729ca4012e313dce957b3cdbe5ac4d56.camel%40opentext.com.

signature.asc (235 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Conventions for names of Jenkins jobs and job stages

mj1414...@gmail.com
In reply to this post by Martin Schmude
Hello Martin,
it's hard to tell you, how your job names should look like. You will need to sit down (with colleagues) and think, what you need.
Here is what we do: ['...' means *our* naming convention for things]
We separate our job names in 'slots'; 'slots' are separated by '-' (because we got names from outside, which use '_' in what could be a content for a slot). We use '.' to separate items in one "slot', if we should need it.
We have the following slots: (you'll see that you need to get your own ;-)

# System component ("Jenkins" for CI-internal stuff)

# duplexMode("FDD"/"TDD")

# HW

# deployment

# branch

# specialBranch

# purpose (build/test/publish/...)

# variant

# discriminator (if we need several jobs of the same type; e.g. for different users)

a: PHY_TX-TDD-HWx-L1-FB2003--test-MIMO-dynamic
If a slot is unused, just the '-' remains, e.g.
b: PHY_TX------ciScriptsUpdate
(and this should have been named JENKINS-... - we have our slips...)

We have a "'jobNameParser' which picks apart these things, and is used so the jobs do what their name says they should do.
(For special jobs, 'b' above, we don't use that; only for more generic like 'a')

The order you choose, should e.g. give a reasonable sorting.
Now you need to find a structure fitting your needs. (*)

Have the appropriate amount of fun

Martin

(*) We had literally discussions on and off over weeks, years ago, before we settled for our current structure.
Martin Schmude schrieb am Mittwoch, 27. Januar 2021 um 17:53:42 UTC+1:
Hello all,
at the department I am working at we operate a Jenkins with ~100 pipeline jobs.
The jobs have evolved over ~4 years without any conventions about job and stage names.
Today we have a mess. Related jobs cannot easily be recognized by name. The "logic" how a job is sectioned into stages is different between all jobs.

We want to clean up and establish naming conventions. Before thinking a lot myself an issue I want to become aware of how others solved it.
Maybe there are well established naming conventions out there that we don't know, but  could adopt easily. At jenkins.io I didn't land a hit.

Any hints? Thank you.

--
You received this message because you are subscribed to the Google Groups "Jenkins Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/4694bd9c-1856-4684-bee4-db552b0f600an%40googlegroups.com.