[06/34] ref-manual: document new github-releases class

Message ID	36af195be9a0425aafd1b8a81a336b5dfd278f42.1665392835.git.paul.eggleton@linux.microsoft.com
State	New
Headers	show Return-Path: <paul.eggleton@linux.microsoft.com> ip: 13.77.154.182, mailfrom: pauleg@linux.microsoft.com) From: Paul Eggleton <paul.eggleton@linux.microsoft.com> To: docs@lists.yoctoproject.org Subject: [PATCH 06/34] ref-manual: document new github-releases class Date: Mon, 10 Oct 2022 02:23:52 -0700 Message-Id: <36af195be9a0425aafd1b8a81a336b5dfd278f42.1665392835.git.paul.eggleton@linux.microsoft.com> In-Reply-To: <cover.1665392835.git.paul.eggleton@linux.microsoft.com> References: <cover.1665392835.git.paul.eggleton@linux.microsoft.com>
Series	[01/34] migration-general: add section on using buildhistory \| expand [01/34] migration-general: add section on using buildhistory [02/34] ref-manual: add DISABLE_STATIC [03/34] ref-manual: expand documentation on image-buildinfo class [04/34] ref-manual: add WATCHDOG_TIMEOUT to variable glossary [05/34] ref-manual: correct default for BUILDHISTORY_COMMIT [06/34] ref-manual: document new github-releases class [07/34] ref-manual: add a note to ssh-server-dropbear feature [08/34] ref-manual: sync supported distro list with code [09/34] ref-manual: update buildpaths QA check documentation [10/34] ref-manual: add UBOOT_MKIMAGE_SIGN [11/34] ref-manual: add DEV_PKG_DEPENDENCY [12/34] ref-manual: add SDK_TOOLCHAIN_LANGS [13/34] ref-manual: add pressure limit variable documentation [14/34] ref-manual: add pypi class [15/34] ref-manual: update pypi documentation for CVE_PRODUCT default in 4.1 [16/34] ref-manual: add CVE_CHECK_SHOW_WARNINGS [17/34] ref-manual: add info on buildtools-make-tarball [18/34] ref-manual: add FIT_PAD_ALG [19/34] ref-manual: add CVE_DB_UPDATE_INTERVAL [20/34] ref-manual: add KERNEL_DEPLOY_DEPEND [21/34] ref-manual: add MOUNT_BASE variable [22/34] ref-manual: remove reference to testimage-auto class [23/34] Update documentation for classes split [24/34] ref-manual: complementary package installation recommends [25/34] ref-manual: remove reference to largefile in DISTRO_FEATURES [26/34] ref-manual: add missing features [27/34] ref-manual: add serial-autologin-root to IMAGE_FEATURES documentation [28/34] ref-manual: add previous overlayfs-etc variables [29/34] ref-manual: add OVERLAYFS_ETC_EXPOSE_LOWER [30/34] ref-manual: add WIRELESS_DAEMON [31/34] ref-manual: add section for create-spdx class [32/34] ref-manual: add overlayfs class variables [33/34] ref-manual: add OVERLAYFS_QA_SKIP [34/34] Add 4.1 migration guide & release notes

Message ID

36af195be9a0425aafd1b8a81a336b5dfd278f42.1665392835.git.paul.eggleton@linux.microsoft.com

State

New

Headers

From: Paul Eggleton <paul.eggleton@linux.microsoft.com>
To: docs@lists.yoctoproject.org
Subject: [PATCH 06/34] ref-manual: document new github-releases class
Date: Mon, 10 Oct 2022 02:23:52 -0700
Message-Id: 
 <36af195be9a0425aafd1b8a81a336b5dfd278f42.1665392835.git.paul.eggleton@linux.microsoft.com>
In-Reply-To: <cover.1665392835.git.paul.eggleton@linux.microsoft.com>
References: <cover.1665392835.git.paul.eggleton@linux.microsoft.com>

Series

[01/34] migration-general: add section on using buildhistory | expand

Commit Message

Paul Eggleton Oct. 10, 2022, 9:23 a.m. UTC

From: Paul Eggleton <paul.eggleton@microsoft.com>

Newly added class in 4.1.

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
---
 documentation/ref-manual/classes.rst   | 14 ++++++++++++++
 documentation/ref-manual/variables.rst |  7 +++++++
 2 files changed, 21 insertions(+)

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index cc0d212..6c60d41 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -659,6 +659,20 @@  the GNU ``gettext`` internationalization and localization system. All
 recipes building software that use ``gettext`` should inherit this
 class.
 
+.. _ref-classes-github-releases:
+
+``github-releases``
+===================
+
+For recipes that fetch release tarballs from github, the ``github-releases``
+class sets up a standard way for checking available upstream versions
+(to support ``devtool upgrade`` and the Automated Upgrade Helper (AUH)).
+
+To use it, add ``github-releases`` to the inherit line in the recipe,
+and if the default value of :term:`GITHUB_BASE_URI` is not suitable,
+then set your own value in the recipe. You should then use ``${GITHUB_BASE_URI}``
+in the value you set for :term:`SRC_URI` within the recipe.
+
 .. _ref-classes-gnomebase:
 
 ``gnomebase.bbclass``
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 81a4ab1..bdc8e3b 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -2768,6 +2768,13 @@  system and gives an overview of their function and contents.
       The directory in which a local copy of a Git repository is stored
       when it is cloned.
 
+   :term:`GITHUB_BASE_URI`
+      When inheriting the :ref:`github-releases <ref-classes-github-releases>`
+      class, specifies the base URL for fetching releases for the github
+      project you wish to fetch sources from. The default value is as follows::
+
+         GITHUB_BASE_URI ?= "https://github.com/${BPN}/${BPN}/releases/"
+
    :term:`GLIBC_GENERATE_LOCALES`
       Specifies the list of GLIBC locales to generate should you not wish
       to generate all LIBC locals, which can be time consuming.

[06/34] ref-manual: document new github-releases class

Commit Message

Patch