Skip to content

Latest commit

 

History

History
148 lines (108 loc) · 3.96 KB

CONTRIBUTING.md

File metadata and controls

148 lines (108 loc) · 3.96 KB
Raw

How is a guide structured?

A guide comprises a README.md and an accompanying bash script. The README is the human readable bit and the script acts as a reproducible set of steps (that can be tested) for the guide. For example, the vgo tour has been rewritten as a Go modules by example guide:

$ ls 001_go_modules_tour
README.md
script.sh

script.sh contains, as its name suggests, the overall script for the guide. It includes a pre-amble that defines a number of helper functions for testing the script, followed by the header:

# **START**

This marks the start of the script.

What follows are a number of optionally commented "blocks". For example, the following block is labelled "install tools" and comprises all the contiguous lines that follow the special # block: comment:

# block: install tools
go install example.com/blah
assert "$? -eq 1" $LINENO

By default, each command is assumed to have an exit code of 0, unless it is followed by an assert line, like above, that asserts otherwise. In this respect, the script behaves much like set -e.

The corresponding README.md acts as a template for the guide itself, but crucially it can reference these blocks to include the commands themselves and/or their output, e.g.:

```
{{PrintBlock "install tools" -}}
```

Look at the raw Go modules by example tour README.md and corresponding script for more examples.

Getting started: regenerating a guide

What follows assumes you have Docker installed.

The following environment variables must also be set:

GITHUB_USERNAME    # your Github username
GITHUB_PAT         # a personal access token with public_repo scope
GITHUB_ORG         # an org/user account where forks, examples will be created
GITHUB_ORG_ARCHIVE # an org/user account where old forks, examples etc will be moved

It's probably a good idea to create a new personal access token specifically for your "fork" of "Go Modules by Example" - you will need public_repo scope.

Creating a new GitHub organisation will allow you to segregate the examples/forks created by your guides (instead of cluttering your personal account). This corresponds to the GITHUB_ORG environment variable above. Similarly, create another organisation that will act as the archive, GITHUB_ORG_ARCHIVE.

Verify that you can pull the required image:

$ docker pull golang
Using default tag: latest
latest: Pulling from library/golang
Digest: sha256:05f8812f1a3e1c9ce44c5a0ba462d1a6d75a0b89abbb2f86b2e02efeda85ce1e
Status: Image is up to date for golang:latest

Clone this repo:

$ git clone https://github.com/go-modules-by-example/index
Cloning into 'index'...
$ cd index

Check that you can use egrunner:

$ gobin -m -run myitcv.io/cmd/egrunner -out std ./000_simple_example/script.sh

should give the output:

go: creating new go.mod: module example.com/simple
$ cd /home/gopher
$ mkdir simple
$ cd simple
$ go mod init example.com/simple
$ go list -m
example.com/simple

Finally check you can use mdreplace:

$ gobin -m -run myitcv.io/cmd/mdreplace -w -long -online ./000_simple_example/README.md