From 8ec0f8bb01c1ba4026cf86f2850be170d6324782 Mon Sep 17 00:00:00 2001 From: Suzanne Soy Date: Fri, 9 Jul 2021 03:55:37 +0100 Subject: [PATCH] Deploy script and links to IPFS --- deploy.sh | 46 ++++++++++++++++++++++++++++++++++++++++++++++ git-tutorial.css | 4 +++- index.html | 25 +++++++++++++++++++++---- 3 files changed, 70 insertions(+), 5 deletions(-) create mode 100755 deploy.sh diff --git a/deploy.sh b/deploy.sh new file mode 100755 index 0000000..63ee0ea --- /dev/null +++ b/deploy.sh @@ -0,0 +1,46 @@ +#!/usr/bin/env bash + +set -euET -o pipefail + +usage() { + printf 'Usage: ./deploy.sh v1'\\n + printf ' v1 will be used as the tag name for this version'\\n +} + +if [ $# -ne 1 ]; then usage; exit 1; fi +if [ "x$1" = "x-h" ] || [ "x$1" = "x--help" ]; then usage; exit 1; fi + +# e.g. v1 +version="$1" +commit_hash="$(git log --format=%H -1 HEAD)" +tempdir="$(mktemp -d)" +tempdirgit="$(mktemp -d)" +this_repo="$PWD" +printf "Temporary directory: %s"\\n "$tempdir" + +# Clone this specific commit (could use a worktree, but I prefer not modifying the original repo if it can be avoided) +git init "$tempdir" +(cd "$tempdir"; git fetch --depth=1 "$this_repo" "$commit_hash") +(cd "$tempdir"; git checkout "$commit_hash") +(cd "$tempdir"; git log) +(set -x; mv "$tempdir/.git" "$tempdirgit/") +ls -a "$tempdir" + +if ! grep ''"$version"'' "$tempdir/index.html"; then + printf "Error: The version number given on the command-line does not match the one in the HTML source code."\\n + exit 1 +fi + +# Add to IPFS and get the hash +ipfs_hash="$(ipfs add --pin=true --recursive --hidden --progress --quieter "$tempdir")" +ipfs_hash="$(ipfs cid base32 "$ipfs_hash")" +printf \\n + +printf %s\\n "$ipfs_hash" + +ipfs name publish --key=git-tutorial "/ipfs/$ipfs_hash" + +sed -i -e 's~ipfs-this-hash-placeholder" href="#"~ipfs-this-hash-placeholder" href="ipfs://'"$ipfs_hash"'/"~' index.html +git commit -m 'Stored IPFS hash of this version' index.html +git tag "$1" +git tag "ipfs-$1-${ipfs_hash}" diff --git a/git-tutorial.css b/git-tutorial.css index a6f685b..74bd60b 100644 --- a/git-tutorial.css +++ b/git-tutorial.css @@ -149,4 +149,6 @@ article#git-tutorial .onlytoc { display: none; } #git-tutorial input[type='button'] { display: inline-block; margin-top: 0.2em; } #git-tutorial .dep-license { display: none; font-size: 80%; width: 100%; overflow-x: auto; } -#git-tutorial .article-metadata { color: #333; font-style: italic; } \ No newline at end of file +#git-tutorial .article-metadata { color: #333; font-style: italic; } + +#git-tutorial .filename { font-family: monospace; } diff --git a/index.html b/index.html index 5e57151..a5a277e 100644 --- a/index.html +++ b/index.html @@ -4,6 +4,15 @@ GIT tutorial + + + + + + + + + @@ -44,7 +53,14 @@ function ___example(id, f) {

By for LIGO. .

-

Please send remarks and suggestions to git-tutorial@suzanne.soy or simply fork this repository on GitHub

+

Please send remarks and suggestions to git-tutorial@suzanne.soy or simply fork this repository on GitHub.

+

This version of the site matches the tag v1 on GitHub. + You can access snapshots of this site via IPFS: + + v1 (permalink), + or check the + latest version via IPNS/IPFS or + via HTTPS.

Credits and license

@@ -863,9 +879,10 @@ END OF TERMS AND CONDITIONS

In order to encourage people to write their own implementation of a version control system, and improve upon the state of the art, the contents of this tutorial (the files -index.html, git-tutorial.js, -git-tutorial.css and README) -and the GIT implementation within are dedicated to the Public Domain, using the +index.html, git-tutorial.js, +git-tutorial.css, deploy.sh +and README, including the GIT implementation contained within) are dedicated +to the Public Domain, using the Creative Commons CC0 1.0 Universal (CC0 1.0) Public Domain Dedication.

The intent is to enable everyone to freely reuse and share part or all of this material under any license, including the CC0, the