Skip to content

🪄 GitHub Action for dynamic template on PR body and title

License

Notifications You must be signed in to change notification settings

flowkey/dynamic-template-action-1

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🪄 GitHub Action for Dynamic Templates

This action uses mustache to enhance the power of GitHub Templates. It allows the templates to include dynamic values that will be populated with the information related to the PR (Pull Request) on pre defined template tags. The most basic usage is for adding the branch name as part of a link to the ticketing system.

For example, in a scenario where the developer is supposed to use branch names that matches the ticket number from JIRA and the link should be present on the PR body, the repository PR template would have something similar to the following:

Related to https://your-jira-url.com/browse/{{head.ref}}

This PR changes:
  - 
  - 
  - 

Where, head.ref is the path on the PR payload to the current branch that will be merged into the base branch. For instance, if the base branch for the current PR is called BUG-123 and the user adds information to the body while creating the PR, it will save the body as:

Related to https://your-jira-url.com/browse/{{head.ref}}

This PR changes:
  - Adds a 500 line snippet from stackoverflow that I don't know how it works,
    but it works

After action execution, the body will be:

Related to https://your-jira-url.com/browse/BUG-123

This PR changes:
  - Adds a 500 line snippet from stackoverflow that I don't know how it works,
    but it works

Inputs

token

The GITHUB_TOKEN secret to access the repository. Defaults to github-actions internal ${{ github.token }} Token.

customInput

The customInput sets additional data to access in your templates. For example data from previous workflow steps. Access it via {{ custom.YOUR_PROPERTY_NAME }}

Example usage

Basic

      - uses: luigibertaco/[email protected]

Can render:

    Your PR was created: {{ head.ref }}

With customInput

      - name: Get current date
        id: date
        run: echo "::set-output name=date::$(date +'%Y-%m-%dT%H:%M:%S')"

      - uses: luigibertaco/[email protected]
        with:
          customInput: 
            today: ${{ steps.date.outputs.date }}
            now: ${{ steps.date.outputs.date }}

Can render:

    Your PR was created: {{ custom.today }}

About

🪄 GitHub Action for dynamic template on PR body and title

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%