docs icon indicating copy to clipboard operation
docs copied to clipboard

Adds missing `{% raw %}` tags to caching page

Open anno1985 opened this issue 3 years ago â€ĸ 5 comments

Why:

Closes https://github.com/github/docs/issues/22864

What's being changed (if available, include any code snippets, screenshots, or gifs):

Adds missing {% raw %} and {% endraw %} tags around three places with rendering issues in the last example on the caching page.

These tags are currently missing, apparently causing the LiquidJS templating engine to attempt to parse GitHub Action expressions from that example and to render them as output. As the expressions aren't LiquidJS output tags, parsing fails, and nothing is rendered.

Check off the following:

  • [x] I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • [ ] ~~For content changes, I have completed the self-review checklist.~~ N/A: added tags only

anno1985 avatar Dec 26 '22 16:12 anno1985

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Dec 26 '22 16:12 welcome[bot]

Automatically generated comment â„šī¸

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
actions/using-workflows/caching-dependencies-to-speed-up-workflows.md fpt
ghec
ghes@ 3.7 3.6 3.5
fpt
ghec
ghes@ 3.7 3.6 3.5

fpt: Free, Pro, Team ghec: GitHub Enterprise Cloud ghes: GitHub Enterprise Server ghae: GitHub AE

github-actions[bot] avatar Dec 26 '22 16:12 github-actions[bot]

Unfortunately, the example is actually re-using a code snippet that is embedded via LiquidJS tags, so disabling them wholesale is not the solution.

anno1985 avatar Dec 26 '22 16:12 anno1985

Looks good to me; however, the section in question (which uses https://github.com/actions/gh-actions-cache/) shows up for ghes 3.7, when it probably shouldn't:

Note: This extension currently supports github.com only, GitHub Enterprise Server is not supported currently.

However, that seems to be an unrelated issue with a variable used in an ifversion tag on lines 317/366:

{% ifversion actions-cache-list-delete-apis %}

anno1985 avatar Dec 26 '22 17:12 anno1985

@anno1985 Thank you for opening a PR and linking it to your issue! ✨

We appreciate all the info provided. 💖 I'll get this triaged for review ⚡

We appreciate your patience during the holiday season 💖

cmwilson21 avatar Dec 27 '22 13:12 cmwilson21

Hey @anno1985, thank you so much for opening this PR! Your updates look great. I'll go ahead and get this merged. 🚀

SiaraMist avatar Jan 17 '23 23:01 SiaraMist

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues :zap:

github-actions[bot] avatar Jan 17 '23 23:01 github-actions[bot]