[Tools-discuss] Template repository for GitHub

Martin Thomson <mt@lowentropy.net> Fri, 16 July 2021 03:14 UTC

Return-Path: <mt@lowentropy.net>
X-Original-To: tools-discuss@ietfa.amsl.com
Delivered-To: tools-discuss@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 3B1E23A21BB for <tools-discuss@ietfa.amsl.com>; Thu, 15 Jul 2021 20:14:32 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.097
X-Spam-Level:
X-Spam-Status: No, score=-2.097 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_BLOCKED=0.001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=lowentropy.net header.b=i8e5aTUV; dkim=pass (2048-bit key) header.d=messagingengine.com header.b=dwt7+zc5
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id FFaBy2F45PPu for <tools-discuss@ietfa.amsl.com>; Thu, 15 Jul 2021 20:14:27 -0700 (PDT)
Received: from out5-smtp.messagingengine.com (out5-smtp.messagingengine.com [66.111.4.29]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 0A2253A21B9 for <tools-discuss@ietf.org>; Thu, 15 Jul 2021 20:14:26 -0700 (PDT)
Received: from compute5.internal (compute5.nyi.internal [10.202.2.45]) by mailout.nyi.internal (Postfix) with ESMTP id ECC9A5C00E3 for <tools-discuss@ietf.org>; Thu, 15 Jul 2021 23:14:21 -0400 (EDT)
Received: from imap41 ([10.202.2.91]) by compute5.internal (MEProxy); Thu, 15 Jul 2021 23:14:21 -0400
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lowentropy.net; h=mime-version:message-id:date:from:to:subject:content-type; s= fm2; bh=PjRYzMz9iChKQ4dNy4zxcVGRMTEf3ceKkWr3Fmum+tA=; b=i8e5aTUV t87hjEPeEtKrdtBPUDBEX3CljE85g5yVKPKZEDQF5To4ht7q4ZUERaD2HVFr58tU bUP9R5FEb2IYSU86l8mDPXvv8bJa6WdXLNWTUla4QQ2Py/xBeut5I8towZ9dVyno UZlbTBzAXR/UW4Bn8mXrmk2mANKnVRKDFAsvmHCFJou03Ioy4qWxC5epQ9nzVGFs /qANHE96z/4AePvIUbseBeX2CV0Fapm6fjyESCRUO87ZUnzr6T5F61JhuUwHWfYS nIEvMm033UhWHTGSdhkN+Ait+d/iqPXxztDWPIdTioDgG7+pqMIrBnkd1b6b5IbF lpYKkXkvLirrIg==
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=content-type:date:from:message-id :mime-version:subject:to:x-me-proxy:x-me-proxy:x-me-sender :x-me-sender:x-sasl-enc; s=fm3; bh=PjRYzMz9iChKQ4dNy4zxcVGRMTEf3 ceKkWr3Fmum+tA=; b=dwt7+zc5U18nerQfOAXXdvEYSCYPmIoEebCun406zTD3S +9nais2vEX6lCF31t4sor1s3fm3hPJD8JVBWHvyK7XKFk5YlSz/cr3DTHiHiLbBN ZTKbyNDfHDJj+UC8jSHEaO55WW3pL8zoBbotqC7oEE0f3xDst3YXYjbcz6Hv4yS1 Bg3j+SCwtbMPktYGGa+ai8p/askB5xUyP6YrxqILcPZAkxufeZS+zKhgImERyF8+ lyuscK7Fs+J5mJu4UFsuimhEpgWXUQSLJbhzc8KiYcqaUCcFuEGfDK3Y1EHSEhUY DTROyr8EtKfsWFP04Eu54XaGZvTOdxNKUssE+MvjA==
X-ME-Sender: <xms:jfnwYLYWBtbCOlk8Ug0BIT209t3uWlbPE5adRlQod03GsLnjAX3r0w> <xme:jfnwYKZLvaR5ImhiR5yTU8xWkCoW4A-96Ixvq5iiNbF6BYtoRQjifmJd3aiQUHE5a iquBMlZu9RM5faQXvo>
X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvtddrvddvgdeifecutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecunecujfgurhepofgfggfkfffhvffutgesthdtredtre ertdenucfhrhhomhepfdforghrthhinhcuvfhhohhmshhonhdfuceomhhtsehlohifvghn thhrohhphidrnhgvtheqnecuggftrfgrthhtvghrnhepieevffekveelleehteefleefhf fggeduudegieffffeujeeufeduvdelveekjeetnecuffhomhgrihhnpehgihhthhhusgdr tghomhdpthgvmhhplhgrthgvrdhmugenucevlhhushhtvghrufhiiigvpedtnecurfgrrh grmhepmhgrihhlfhhrohhmpehmtheslhhofigvnhhtrhhophihrdhnvght
X-ME-Proxy: <xmx:jfnwYN-x-N5TfiQAwOOF7AtlMzDFtEt7uC4uWyJLxpcJOMVpfUpnSw> <xmx:jfnwYBqCKQA928ATK5H1FY5XuPLnECVSkuHe7HF4MGCEnG3UI9bu7Q> <xmx:jfnwYGqFyxTjvjRbKwQCP8jgCnQowgTiX3CIMweujm-RO4cNvjYf4A> <xmx:jfnwYD1igj1h_kKLVEj3zxd9g_0gqrFPXqY1E7huvwyIQGqpbyuDAQ>
Received: by mailuser.nyi.internal (Postfix, from userid 501) id A66F33C0CFD; Thu, 15 Jul 2021 23:14:21 -0400 (EDT)
X-Mailer: MessagingEngine.com Webmail Interface
User-Agent: Cyrus-JMAP/3.5.0-alpha0-533-gf73e617b8a-fm-20210712.002-gf73e617b
Mime-Version: 1.0
Message-Id: <5391988e-7180-49d3-989b-3cf40e395408@www.fastmail.com>
Date: Fri, 16 Jul 2021 13:14:04 +1000
From: "Martin Thomson" <mt@lowentropy.net>
To: tools-discuss@ietf.org
Content-Type: text/plain
Archived-At: <https://mailarchive.ietf.org/arch/msg/tools-discuss/JSYTjh8Ho35l8oPOXta7d5C-KAk>
Subject: [Tools-discuss] Template repository for GitHub
X-BeenThere: tools-discuss@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: IETF Tools Discussion <tools-discuss.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/tools-discuss>, <mailto:tools-discuss-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/tools-discuss/>
List-Post: <mailto:tools-discuss@ietf.org>
List-Help: <mailto:tools-discuss-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/tools-discuss>, <mailto:tools-discuss-request@ietf.org?subject=subscribe>
X-List-Received-Date: Fri, 16 Jul 2021 03:14:32 -0000

Hey,

Anyone who has setup a new GitHub repository for an Internet-Draft knows that it can be a little tricky, particularly if you use the toolchain I support.

Not any more.  I've created a template repository that makes setup very simple.  Just create a new repository using the template, rename your draft, enable GitHub Pages, and you are ready to go.

You can run all of this from the web UI that GitHub provides.  That includes publishing drafts to datatracker, which is done by creating a release[*].

Some credit here is owed to Mallory Knodel for complaining loudly enough about how unfriendly this whole setup was and motivating me to spend a couple of hours on finally doing this.

Documentation here:
https://github.com/martinthomson/i-d-template/blob/main/doc/TEMPLATE.md

As always contributions and bug reports are welcome.

Cheers,
Martin

[*] This bit isn't completely tested yet, I'll confess.