bdougie / variables-in-markdown

This GitHub Action will allow you to set variables in Markdown and allow you to interpolate throughout your file.

Variables in Markdown

This GitHub Action will allow you to set variables in Markdown and interpolate throughout your GitHub Issue.

Usage

This GitHub Action that replaces template in your variables

on: issues
name: Template Variables in Markdown
jobs:
  markdown:
    name: markdown-marker
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - uses: bdougie/variables-in-markdown@master
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Testing

This action is best used with issue templates. Create an example .github/ISSUE_TEMPLATE.md file. This file should have front matter to help construct the new issue:

---
title: New Issue
labels: bug, enhancement
---
<!--#
NOUN=mother
ATTRIBUTION=Mark Wahlberg
$-->

"Say hi to your {{ NOUN }} for me," {{ ATTRIBUTION }}

You'll notice that the above example has some {{ MUSTACHE }} variables. This is needed for the API to find and replace variables. This is powered by the marky_markdown ruby gem.

variables-in-markdown's Issues

add ability to update pull request copy

At the moment the code for this action is the only issue-specific and should cover pull requests too.

[Enhancement] Extended template capability

I'm just wondering if that makes sense. Possibility to create a template of some functional piece of Markdown.
Example below

title: New Issue
labels: bug, enhancement
---
<!--#
thumbnail = [<img src="$1" width="$2"/>]($1)
IMAGE1 = ./static/iamge1.png

$-->

A thumbnail:  
{{ thumbnail(IMAGE1, 250) }}

Generated markdown:
[<img src="./static/iamge1.png" width="250"/>](./static/iamge1.png)

filter actions for open issues only

This action will run on every issue. I have added a failure case to stop subsequent runs, but there has to be a better way to add filtering.

Previously in Actions V1 you could use https://github.com/actions/bin-filter but this is not available in V2.

In V2, you can filter branches using the following:

- run: echo hello
  if: github.ref == 'refs/heads/master'

curious if you can do something for specific events