Blog - Embedded Artistry

28 December 201715 December 2021

Jenkins: Generating Blue Ocean URLs

I just finished setting up a Jenkins build server for a client. This client wanted to use Blue Ocean, the new attractive and streamlined user interface for Jenkins Pipeline projects. Once Blue Ocean is installed, users can switch between the standard Jenkins interface and the Blue Ocean interface at will. However, many users interact with …

Continue reading "Jenkins: Generating Blue Ocean URLs"

21 December 201721 April 2020

Jenkins: Kick off a CI Build with GitHub Push Notifications

When creating a Jenkins multi-branch pipeline job, builds will be triggered based on the rules set for each job. By default, each repository is scanned on a timer (e.g. every 30min, once a day) and builds are triggered if new commits or pull requests have been made since the last scan. However, what I really …

Continue reading "Jenkins: Kick off a CI Build with GitHub Push Notifications"

18 December 201715 December 2021

Missing headers after an OSX Update? Try this!

I recently opened my Macbook to start working on a few personal projects, and suddenly I noticed that all of my projects were failing to compile. I was pretty surprised - I'm not one to leave my master branch in a broken state! I finally paid attention to the problem the compiler was complaining about: …

Continue reading "Missing headers after an OSX Update? Try this!"

14 December 201714 December 2021

Embedded Artistry CONTRIBUTING Template

In the last post we looked at the elements of a high-quality CONTRIBUTING guide. Today I'd like to share my CONTRIBUTING template with you. This template is a starting point: feel free to add or remove sections based on the specifics of your project. Remember, you don't have to start with an amazing CONTRIBUTING guide. …

Continue reading "Embedded Artistry CONTRIBUTING Template"

11 December 201715 December 2021

Get Others Involved in Your Project with a CONTRIBUTING Guide

I recently shared a README Template and strategies for improving your project's README. The README's purpose is to introduce new users to your project and help them start using it. Today we're going to take a look at another helpful introductory document: the CONTRIBUTING guide. Every software project comes with its own particular development process, …

Continue reading "Get Others Involved in Your Project with a CONTRIBUTING Guide"

7 December 201720 January 2022

Use Semantic Versioning and Give Your Version Numbers Meaning

It's pretty amazing that in 2017 I still find plenty of projects with no versioning, a random version scheme, or stuck perpetually at 0.1.x. Figuring out the maturity of these projects or the scope of changes between two versions can be terribly difficult. Versioning without any guidelines produces meaningless versions, so we need to follow …

Continue reading "Use Semantic Versioning and Give Your Version Numbers Meaning"

30 November 201724 August 2021

Embedded Artistry README Template

I previously shared tips for writing a better README. Now I'd like to share our README template with you. This template is probably much more involved that other README files that you have seen. This template is meant for developers who are committed to a standard of excellence and want to provide quality documentation for their …

Continue reading "Embedded Artistry README Template"

27 November 201715 December 2021

Your Project is Great, So Let’s Make Your README Great Too

I can’t recall how many times I’ve stumbled across an interesting project, been excited to start using it, and opened up the README to see… nothing. Often it’s just a simple initial one-liner that GitHub auto-generates for your repository. In better cases there may be some basic (out-of-date) instructions, but mostly I’m still left with …

Continue reading "Your Project is Great, So Let’s Make Your README Great Too"

23 November 201721 April 2020

An Open Source Koan

This story wasn't written by me, but I've always loved it and want to pass it on to you. An Open Source Koan A UNIX wizard hears cries of torment from his apprentice's computer room where the apprentice is studying, and goes to investigate. He finds the apprentice in obvious distress, nearly on the verge …

Continue reading "An Open Source Koan"

16 November 201715 December 2021

Jenkins: Running Steps as sudo

I came across a situation recently where I needed my Jenkins user to be able to run commands as sudo. I have a job that is scheduled nightly to install and update dependencies prior to running my builds. Since apt-get needs to be run with sudo, I needed some way to workaround the password input …

Continue reading "Jenkins: Running Steps as sudo"