From: David Bremner <david@tethera.net>
To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org
Subject: [PATCH] build: upload html docs as part of release process
Date: Thu, 16 Jul 2020 08:11:26 -0300 [thread overview]
Message-ID: <20200716111126.3223050-1-david@tethera.net> (raw)
In-Reply-To: <20200716110314.3219350-1-david@tethera.net>
Use a URL https://notmuchmail.org/doc/latest to leave room for a
future more ambitious scheme deploying multiple versions.
This also forces the html docs to built as part of the release
process. In the future this should be updated to tolerate generating a
release without sphinx installed. This needs a new target analogous to
build-info and build-man that does nothing if sphinx is not installed.
---
Oops. Of course as soon as I send it I see a flaw. It's hard to test
this stuff without doing another release; in some sense this patch is
a reminder to me to debug it next time I do a release.
Makefile.global | 1 +
Makefile.local | 3 ++-
2 files changed, 3 insertions(+), 1 deletion(-)
diff --git a/Makefile.global b/Makefile.global
index 98b6962e..4fd796e3 100644
--- a/Makefile.global
+++ b/Makefile.global
@@ -39,6 +39,7 @@ DEB_TAG=debian/$(UPSTREAM_TAG)-1
RELEASE_HOST=notmuchmail.org
RELEASE_DIR=/srv/notmuchmail.org/www/releases
+DOC_DIR=/srv/notmuchmail.org/www/doc/latest
RELEASE_URL=https://notmuchmail.org/releases
TAR_FILE=$(PACKAGE)-$(VERSION).tar.xz
ELPA_FILE:=$(PACKAGE)-emacs-$(ELPA_VERSION).tar
diff --git a/Makefile.local b/Makefile.local
index 22577617..39f36d50 100644
--- a/Makefile.local
+++ b/Makefile.local
@@ -64,7 +64,7 @@ update-versions:
# are part of the release and need to take the version from the
# version file).
.PHONY: release
-release: verify-source-tree-and-version
+release: verify-source-tree-and-version sphinx-html
$(MAKE) VERSION=$(VERSION) verify-newer
$(MAKE) VERSION=$(VERSION) clean
$(MAKE) VERSION=$(VERSION) test
@@ -80,6 +80,7 @@ ifeq ($(REALLY_UPLOAD),yes)
git push origin $(VERSION) $(DEB_TAG) release pristine-tar
cd releases && scp $(TAR_FILE) $(SHA256_FILE) $(DETACHED_SIG_FILE) $(RELEASE_HOST):$(RELEASE_DIR)
ssh $(RELEASE_HOST) "rm -f $(RELEASE_DIR)/LATEST-$(PACKAGE)-* ; ln -s $(TAR_FILE) $(RELEASE_DIR)/LATEST-$(TAR_FILE)"
+ rsync --verbose --delete --recursive doc/_build/html/ $(RELEASE_HOST):$(DOC_DIR)
endif
@echo "Please send a release announcement using $(PACKAGE)-$(VERSION).announce as a template."
--
2.27.0
next prev parent reply other threads:[~2020-07-16 11:11 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-16 11:03 [PATCH] build: upload html docs as part of release process David Bremner
2020-07-16 11:11 ` David Bremner [this message]
2020-08-04 1:39 ` David Bremner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200716111126.3223050-1-david@tethera.net \
--to=david@tethera.net \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).