Discover gists

Playbook: Creating a GitHub Integration Plugin for Backstage

Overview

This playbook outlines the steps to create a plugin for Backstage that integrates with GitHub to do user specified tasks.

What's Needed From User

GitHub repository URL.
Access token with appropriate permissions for accessing the repository.

Code is clean if it can be understood easily – by everyone on the team. Clean code can be read and enhanced by a developer other than its original author. With understandability comes readability, changeability, extensibility and maintainability.

General rules

Follow standard conventions.
Keep it simple stupid. Simpler is always better. Reduce complexity as much as possible.
Boy scout rule. Leave the campground cleaner than you found it.
Always find root cause. Always look for the root cause of a problem.

Design rules

So, You Want to be a Systems Engineer

Systems Engineering (also known as Infrastructure Engineering, Operations Engineering, or DevOps) is a challenging but rewarding career path. Because Systems Engineering draws from a wide variety of smaller topics, it can be hard to know where to start and in what order to begin. This resource is intended to give you a sketch of some of the learning-paths that that can lead you to a career in Systems Engineering.

What do I need to know?

To start, let's examine a high-level list of topics that established systems engineers should have knowledge of. In each of these topics, the level of depth required to get started as a systems engineer may vary, but it's good to have a general breadth of knowledge on all of these topics.

These lists are not exhaustive, rather a good starting point to gain general knowledge.

	<!DOCTYPE html>
	<html lang="en">
	<head>
	<meta charset="UTF-8">
	<meta name="viewport" content="width=device-width, initial-scale=1.0">
	<title>2D Platformer Game</title>
	<style>
	canvas {
	border: 1px solid black;
	display: block;

	import plistlib
	import struct
	import logging
	import lief
	import sys
	from typing import List
	from macholib import MachO, mach_o

	logger = logging.getLogger(__name__)

	'use server';

	export const signUpAction = apiAction(
	signUpFormSchema,
	async (data): Promise<{ }> => {
	// ...
	},
	);

	# This code is licensed under the terms of the MIT license https://opensource.org/license/mit
	# Copyright (c) 2021 Marat Reymers

	## Golden config for golangci-lint v1.58.0
	#
	# This is the best config for golangci-lint based on my experience and opinion.
	# It is very strict, but not extremely strict.
	# Feel free to adapt and change it for your needs.

	run:

	#!/bin/bash
	#####################################################
	# Name: Bash CheatSheet for Mac OSX
	#
	# A little overlook of the Bash basics
	#
	# Usage:
	#
	# Author: J. Le Coupanec
	# Date: 2014/11/04