From patchwork Thu Feb 27 09:08:53 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Leonard_G=C3=B6hrs?= X-Patchwork-Id: 58019 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id D7182C282C1 for ; Thu, 27 Feb 2025 09:09:07 +0000 (UTC) Received: from metis.whiteo.stw.pengutronix.de (metis.whiteo.stw.pengutronix.de [185.203.201.7]) by mx.groups.io with SMTP id smtpd.web11.6978.1740647344212473628 for ; Thu, 27 Feb 2025 01:09:04 -0800 Authentication-Results: mx.groups.io; dkim=none (message not signed); spf=pass (domain: pengutronix.de, ip: 185.203.201.7, mailfrom: lgo@pengutronix.de) Received: from drehscheibe.grey.stw.pengutronix.de ([2a0a:edc0:0:c01:1d::a2]) by metis.whiteo.stw.pengutronix.de with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1tnZt8-0002IU-28; Thu, 27 Feb 2025 10:09:02 +0100 Received: from dude03.red.stw.pengutronix.de ([2a0a:edc0:0:1101:1d::39]) by drehscheibe.grey.stw.pengutronix.de with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.96) (envelope-from ) id 1tnZt7-0036DJ-1o; Thu, 27 Feb 2025 10:09:01 +0100 Received: from lgo by dude03.red.stw.pengutronix.de with local (Exim 4.96) (envelope-from ) id 1tnZt7-006qep-1Y; Thu, 27 Feb 2025 10:09:01 +0100 From: =?utf-8?q?Leonard_G=C3=B6hrs?= To: bitbake-devel@lists.openembedded.org Cc: docs@lists.yoctoproject.org, yocto@pengutronix.de, =?utf-8?q?Leonard_G?= =?utf-8?q?=C3=B6hrs?= Subject: [PATCH v2 5/5] doc: document the GitHub Release Artifact fetcher and GH_TOKEN Date: Thu, 27 Feb 2025 10:08:53 +0100 Message-Id: <20250227090853.1632280-6-l.goehrs@pengutronix.de> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20250227090853.1632280-1-l.goehrs@pengutronix.de> References: <20250227090853.1632280-1-l.goehrs@pengutronix.de> MIME-Version: 1.0 X-SA-Exim-Connect-IP: 2a0a:edc0:0:c01:1d::a2 X-SA-Exim-Mail-From: lgo@pengutronix.de X-SA-Exim-Scanned: No (on metis.whiteo.stw.pengutronix.de); SAEximRunCond expanded to false X-PTX-Original-Recipient: docs@lists.yoctoproject.org List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Thu, 27 Feb 2025 09:09:07 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/6463 The fetcher is quite niche, as it is only required when working with private GitHub repositories (public releases have a stable public download URL and do not need any authentication). Hence it is only documented like a niche feature. Signed-off-by: Leonard Göhrs Reviewed-by: Antonin Godard --- .../bitbake-user-manual-fetching.rst | 2 ++ .../bitbake-user-manual-ref-variables.rst | 13 +++++++++++++ 2 files changed, 15 insertions(+) diff --git a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst index fb4f0a23d..2f5224482 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst +++ b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst @@ -842,6 +842,8 @@ Fetch submodules also exist for the following: - Trees using Git Annex (``gitannex://``) +- Private GitHub Release Artifacts (``ghra://``) + No documentation currently exists for these lesser used fetcher submodules. However, you might find the code helpful and readable. diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst index 858de6347..228443e0b 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst @@ -1083,6 +1083,19 @@ overview of their function and contents. layer containing the recipe file. Code can use this to identify which layer a recipe is from. + :term:`GH_TOKEN` + GitHub Access Token. When using the + :ref:`GitHub Release Artifact fetcher ` + This variable can be defined to be used by the fetcher to authenticate + and gain access to non-public release artifacts:: + + GH_TOKEN = "github_pat_..." + + Alternatively, the token can be specified in :term:`SRC_URI` with the ``token`` + parameter:: + + SRC_URI = "ghra://github.com...;token=github_pat_..." + :term:`GITDIR` The directory in which a local copy of a Git repository is stored when it is cloned.