| Message ID | 20250225070631.2262115-5-l.goehrs@pengutronix.de |
|---|---|
| State | New |
| Headers | show |
| Series | [v1,1/5] fetch2/wget: enable classes derived from Wget to set custom http headers | expand |
Hi Leonard, On Tue Feb 25, 2025 at 8:06 AM CET, Leonard Göhrs wrote: > 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> > --- > doc/bitbake-user-manual/bitbake-user-manual-fetching.rst | 2 ++ > .../bitbake-user-manual-ref-variables.rst | 8 ++++++++ > 2 files changed, 10 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 ad219b531..258c4035d 100644 > --- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst > +++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst > @@ -1078,6 +1078,14 @@ 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 <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:: > + > + GH_TOKEN = "github_pat_..." Nit: we indent code blocks with three spaces. Should we also mention that the token can be passed a URL parameter? Something like: """ Alternatively, the token can be specified in :term:`SRC_URI` with the ``token`` parameter:: SRC_URI = "ghra://github.com...;token=github_pat_..." """ Antonin
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 ad219b531..258c4035d 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst @@ -1078,6 +1078,14 @@ 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 <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:: + + GH_TOKEN = "github_pat_..." + :term:`GITDIR` The directory in which a local copy of a Git repository is stored when it is cloned.
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> --- doc/bitbake-user-manual/bitbake-user-manual-fetching.rst | 2 ++ .../bitbake-user-manual-ref-variables.rst | 8 ++++++++ 2 files changed, 10 insertions(+)