feat: auto update ipfs version in installation docs

[laurentsenta]

• Add a current-ipfs-version frontmatter option to make the feature opt-in,
• Add a search & replace on the ipfs tag.

[welcome]

Thank you for submitting this PR!
A maintainer will be here shortly to review it.
We are super grateful, but we are also overloaded! Help us by making sure that:

• The context for this PR is clear, with relevant discussion, decisions and stakeholders linked/mentioned.
• Your contribution itself is clear (grammar and spelling checked, any code blocks checked and commented) and in its best form. Follow the docs contribution guidelines if they apply.

Getting other community members to do a review would be great help too on complex PRs (you can ask in the chats/forums). If you are unsure about something, just leave us a comment.
Next steps:

• A maintainer will triage and assign priority to this PR, commenting on any missing things and potentially assigning a reviewer for high priority items.
• The PR gets reviews, discussed and approvals as needed.
• The PR is merged by maintainers when it has been approved and comments addressed.

We currently aim to provide initial feedback/triaging within two business days. Please keep an eye on any labelling actions, as these will indicate priorities and status of your contribution.
We are very grateful for your contribution!

[laurentsenta]

👋 I've experienced this issue a couple of days ago and took a stab at it,
(see also #1074).

(requesting @galargh to preshot the ci code quality before pinging the maintainers)

[galargh]

nit: If you place your substitution part after update http-api-docs section, you'd be free to cd $ROOT/docs.

Needs small fixes but overall I think it'd be a quick win here if the maintainers are OK with it. Another approach would be to adopt some proper templating engine for docs generation and use ipfs tag as an input but that's a major undertaking compared to this change so I think we can put it off for now.

[galargh]

Is a situation in which we'd want references to $CURRENT_IPFS_TAG survive a new IPFS tag release? Some that I can think of:

• referring to an older version of IPFS to highlight some differences between the versions
• referring to a version of some other thing that just happens to be the same as $CURRENT_IPFS_TAG

[laurentsenta]

👍 Definitely limitations of not using a real templating system.

My assumption is that these are unlikely to happen or might happen once, which will catch at review time.
Because we have the frontmatter requirement and we only transform current version to new version.
(if we document something about versionX specifically, it will be replaced only when we upgrade ipfs from versionX to versionY).

(will let you and the maintainers ack on this)

[galargh]

Cool with me, thank you for the reply :) That's 👍 from me, I'll let you follow up with the maintainers now.

[laurentsenta]

Commenting here so we get a thread & trace some research:

Needs small fixes but overall I think it'd be a quick win here if the maintainers are OK with it. Another approach would be to adopt some proper templating engine for docs generation and use ipfs tag as an input but that's a major undertaking compared to this change so I think we can put it off for now.

Agreed, thanks for the feedback @galargh,

FWIW:

There is also a templating feature in vuepress,
but the syntax seems to break markdown URLs. This won't be transformed into a link:

[my link](https://mysite.com/{{ $frontmatter.myVariable }})

And we can't use templating in code blocks.

We could write vuepress plugins, but it would be more time-consuming & invasive.

[filecorgi]

• Image optimization came back clean!
• Vuepress build was successful!

[johnnymatthews]

This looks good from my end. Might wanna get a SWE to double check stuff though.

[johnnymatthews]

@lidel do you mind giving this PR a look over? My automation skills are pretty lax.

[lidel]

LGTM, but it seems CI shell is no longer bash and we also had dependabot enabled with impacted this workflow.

See follow-up fixes in #1121

[lidel]

@laurentsenta turns out when <<< is used we need to make sure we use bash and not sh – see fix in #1121