diff mbox series

[v3,5/5] doc: document the GitHub Release Artifact fetcher and BB_FETCH_GHRA_TOKEN

Message ID 20250307120055.1816436-6-l.goehrs@pengutronix.de
State New
Headers show
Series fetch2/github_release_artifact: fetcher for (private) release artifacts | expand

Commit Message

Leonard Göhrs March 7, 2025, noon UTC
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 <l.goehrs@pengutronix.de>
---
 .../bitbake-user-manual-fetching.rst                 |  2 ++
 .../bitbake-user-manual-ref-variables.rst            | 12 ++++++++++++
 2 files changed, 14 insertions(+)
diff mbox series

Patch

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 dd8cf2409..51bb336b0 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
@@ -1098,6 +1098,18 @@  overview of their function and contents.
       layer containing the recipe file. Code can use this to identify which
       layer a recipe is from.
 
+   :term:`BB_FETCH_GHRA_TOKEN`
+      GitHub Access Token. When using the
+      :ref:`GitHub Release Artifact fetcher <bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`
+      This variable can be defined to be used by the fetcher to authenticate
+      and gain access to non-public release artifacts::
+
+         BB_FETCH_GHRA_TOKEN = "github_pat_..."
+
+      Make sure to always use fine-grained personal access tokens that only
+      enable downloading of artifacts in the relevant repositories or the
+      short-lived access tokens provided to GitHub actions.
+
    :term:`GITDIR`
       The directory in which a local copy of a Git repository is stored
       when it is cloned.