Skip to content

Incomplete CI snippets in docs #926

@rsenden

Description

@rsenden

Current Behavior

See for example following screenshot, taken from https://fortify.github.io/fcli/v3/ci/github/v3.0.x/ast-action-ssc.html:

Image

Expected Behavior

Snippets should show proper secret/variable references, like ${{secrets.SSC_TOKEN}}

Steps To Reproduce

No response

Environment

Anything else?

We're already escaping the $ sign in document generation to avoid those expressions being interpreted as SpEL expressions, however the double curly braces are probably interpreted by Jekyll during gh-pages generation. There's a Jekyll raw instruction that could potentially avoid this, however given that we convert the same AsciiDoc to both plain HTML and Jekyll pages, we can't include raw instructions in the AsciiDoc itself, as that would then show up in HTML. We may need to handle this at template level, i.e., embedding full document contents in raw Jekyll block (but note that some page elements do contain Jekyll instructions, like version selector in banner, and some page contents like on the main fcli version selection landing page).

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions