foodogsquared/asciidoctor-foodogsquared-extensions
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/asciidoctor-foodogsquared-extensions.git synced 2025-01-31 10:58:11 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
869181bafa
asciidoctor-foodogsquared-e.../lib/asciidoctor/swhid-include-processor
History
Gabriel Arazas 869181bafa Update Asciidoctor extension dependency 
Asciidoctor already handles the caching so we don't really need to. On
the plus side, it gives some choice whether the pipeline should have a
cache or not.
2023-05-28 17:49:15 +08:00
..
extension.rb Update Asciidoctor extension dependency 2023-05-28 17:49:15 +08:00
README.adoc Revise notes for custom Asciidoctor extensions 2023-03-12 10:07:38 +08:00

README.adoc

Table of Contents

This is an include processor extension for easily fetching SWHIDs, only with the cnt schema type.

Synopsis

include::$SWHID[]

Where $SWHID is a SWHID. This could accept SWHIDs with qualifiers.

Take note this include processor will only give the raw content with the cnt schema type. Anything else will be skipped and log a warning instead.

Extra notes

= doctitle
:swhid-gpl3: swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2

include::{swhid-nixpkgs}[]

This include processor also respects the safe mode setting. This means in order to permit including by SWHID, you have to permit includes by URIs.

Lastly, this include processor uses the Software Heritage API which includes a limitation. You could create authorized requests by setting SWH_API_BEARER_TOKEN environment variable with a token.

Example usage

  • SWHID with a bare core identifier: include::swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2[].

  • SWHID with full contextual information: include::swh:1:cnt:4c6ad635164b25b9bc2ebe17d2c3b7c0835f6035;origin=https://github.com/NixOS/nixpkgs;visit=swh:1:snp:6ea7d28dfd4789609e0be2b64179fc9c12931beb;anchor=swh:1:rev:7f5639fa3b68054ca0b062866dc62b22c3f11505;path=/README.md.