Alex Atkinson AlexAtkinson

Jira Workflow Examples

This GIST is here simply to demonstrate some workflows I've found helpful in guaranteeing a well-developed backlog for iteration teams. That said, workflows can be as simple or as complex as you need for your organization/project. At scale though, it's highly desirable to have a backlog as beautifully maintained as your products as their qualities are interdependent. And you'll see this point surface in retrospectives/feedback over time.

Structure

First off, DO NOT have workflows that looks like this:

Versioning

RELATED: Artifacting.md

Versioning is an ancient problem, but this GIST mostly focuses on the computing era and versioning for software. This primer details a few versioning tactics along with some advisories and warnings.

Who is this for? Historically this would have been the bread and butter of the Release Manager, but these majestic creatures are long extinct. These days DevOps is responsbile for automating the SDLC, but this material can only serve to enrich anyone interested in or involved in the software industry.

AdHoc

Artifacting

RELATED: Versioning.md

This primer on artifacting demonstrates how to package files as zip and tar.gz, leverage a .artifactignore file similar to .gitignore, and generate and use a checksum file.

Artifacting is the process of packaging a project for distribution and/or release, and is essential to the SDLC as it mitigates many risks in both producing and consuming software products. Aside from archives, there are binaries and other language specific formats and frameworks that have their own packaging methods, but they are outside of the scope of this document. If you're interested, the serverless packaging mechanism is a good demonstration of some of the same concpets discussed here.

Generally artifacts should conform to a standard naming scheme such as: '\_.'.

HTML Tags You Can Use on GitHub

Wherever HTML is rendered on GitHub (gists, README files in repos, comments on issues and pull requests, ...) you can use any of the HTML elements that GitHub Flavored Markdown (GFM) provides syntactic sugar for. You can either use the syntactic sugar that GFM (or other GitHub-supported markup language you're using) provides or, since Markdown can contain raw HTML, you can enter the HTML tags manually.

But GitHub also allows you to use a few HTML elements beyond what Markdown provides by entering the tags manually, and some of them are styled with CSS. Most raw HTML tags get stripped before rendering the HTML. Those tags that can be generated by GFM syntactic sugar, plus a few more, are whitelisted. These aren't documented anywhere that I can find. Here's what I've discovered so far:

`<details>` and `<summary>`

A `<detai

	# Prints a section header.
	#
	# Features
	# - Autosizes to terminal if $width -gt $COLUMNS
	# - Specifying width as 4000 works...
	# - Adjust first two sanities for stricter usage
	# * Currently sets width to half terminal width
	# * Currently rounds down odd to even width automatically
	# - Customizable outside and inside fill characters
	# - Nofill style option