From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Jonas Bernoulli Newsgroups: gmane.emacs.bugs Subject: bug#53221: Keeping Version header and tag in sync Date: Wed, 12 Jan 2022 19:34:06 +0100 Message-ID: <8735lspzvl.fsf@bernoul.li> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="31729"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Stefan Kangas To: 53221@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Jan 12 19:36:18 2022 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from [209.51.188.17] (helo=lists.gnu.org) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1n7iTq-00084q-5e for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 12 Jan 2022 19:36:18 +0100 Original-Received: from localhost ([::1]:46726 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1n7iTo-0006ga-WD for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 12 Jan 2022 13:36:17 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:46308) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1n7iTM-0006fx-U0 for bug-gnu-emacs@gnu.org; Wed, 12 Jan 2022 13:35:48 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:37932) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1n7iSc-0002iD-RI for bug-gnu-emacs@gnu.org; Wed, 12 Jan 2022 13:35:24 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1n7iSc-0000CN-Pa for bug-gnu-emacs@gnu.org; Wed, 12 Jan 2022 13:35:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Jonas Bernoulli Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 12 Jan 2022 18:35:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 53221 X-GNU-PR-Package: emacs X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.1642012463695 (code B ref -1); Wed, 12 Jan 2022 18:35:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 12 Jan 2022 18:34:23 +0000 Original-Received: from localhost ([127.0.0.1]:59068 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1n7iRy-0000B9-Qy for submit@debbugs.gnu.org; Wed, 12 Jan 2022 13:34:23 -0500 Original-Received: from lists.gnu.org ([209.51.188.17]:48380) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1n7iRw-00009w-1P for submit@debbugs.gnu.org; Wed, 12 Jan 2022 13:34:21 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:45984) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1n7iRs-0006cI-0h for bug-gnu-emacs@gnu.org; Wed, 12 Jan 2022 13:34:19 -0500 Original-Received: from mail.hostpark.net ([212.243.197.30]:38592) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1n7iRp-0002XK-FJ for bug-gnu-emacs@gnu.org; Wed, 12 Jan 2022 13:34:15 -0500 Original-Received: from localhost (localhost [127.0.0.1]) by mail.hostpark.net (Postfix) with ESMTP id 7836F160EE; Wed, 12 Jan 2022 19:34:08 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=bernoul.li; h= content-type:content-type:mime-version:message-id:date:date :subject:subject:from:from:received:received; s=sel2011a; t= 1642012446; bh=J8D5H1yDDxsLqmzdtuXbNWiKM9tjNrh67Mh+lAj0rzo=; b=K CqvJtyxqu0cpxv/DZZB4SdFO7z8AQPDDTPuZ/q99brbOW2jT696/BmFU3gXuWl+z 7G1zFU25nF1Tj9EtT78N2tnalRW4f8my+6GHZ2yhn8iLokxPr7HaFV81L/RCxPh1 x9tO03u2FbXDRRORwj/Uf+mZbKSx/71JYOq4Tv+lnc= X-Virus-Scanned: by Hostpark/NetZone Mailprotection at hostpark.net Original-Received: from mail.hostpark.net ([127.0.0.1]) by localhost (mail1.hostpark.net [127.0.0.1]) (amavisd-new, port 10224) with ESMTP id 7TRxgXh6iplH; Wed, 12 Jan 2022 19:34:06 +0100 (CET) Original-Received: from customer (localhost [127.0.0.1]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-256) server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mail.hostpark.net (Postfix) with ESMTPSA id 4ACDB164A8; Wed, 12 Jan 2022 19:34:06 +0100 (CET) Received-SPF: none client-ip=212.243.197.30; envelope-from=jonas@bernoul.li; helo=mail.hostpark.net X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 5.0 requ) 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_LOW=-0.7, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_NONE=0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:224025 Archived-At: Hello, I have brought this up elsewhere and Stefan Kangas asked me to repeat it here so we don't forget about it. 1: https://github.com/magit/orgit/pull/45 [Non]GNU Elpa uses the [Package-]Version header to determine a package's version, while Melpa Stable uses the latest Git/Hg version tag. (Let's not talk about what Melpa "bleeding edge" does.) It is desirable that these package archives as well as other tools that use either one of these techniques agree which commit a version string refers too. To accomplish this we have to bump the version in both locations at the same time. At the exact same time! One should not bump the Version header in one commit, add a few more commits, and then tag the latest commit with the same version as was first used in the library header a few commits earlier. We are stuck with two sources for the same information and we should try hard to keep these two sources in agreement. This also means that when we invite new packages into [Non]GNU Elpa and instruct their maintainers to add the Version header, that we then also make them aware of this complication. IMO this is how it should be done given the current schism: 1. Update the `Version` header keyword. 2. Possibly make other release-related changes like updating the `NEWS` file or updating the version in manuals and such. 3. Create a commit with a message like "Release version VERSION", where VERSION is exactly the same version as used in the header. 4. Tag that commit using the same version as used in the header and commit message (optionally prefixed with `v` because that is the Git convention). Ideally the tag is signed and annotated. If it is annotated, then it should use a message like "Release version VERSION" or "PACKAGE-NAME VERSION". 5. When pushing the release commit, then don't forget to push the release tag as well. Obviously it would be nice to say the above with less words. ;) Jonas