Markdown

Use the comment field to post freeform markdown. No templates, no validation - just write your markdown and it shows up in the PR.

Basic Usage


- name: Post Markdown Comment
  uses: dev-herald/comment@v1
  with:
    api-key: ${{ secrets.DEV_HERALD_API_KEY }}
    pr-number: ${{ github.event.pull_request.number }}
    comment: |
      ## Build Complete! 🎉
      
      ✅ All checks passed
      📦 Build artifacts ready

Templates vs. Markdown

Feature	Templates	Markdown
Structure	Pre-defined schema	Freeform
Validation	Schema-validated	None
Flexibility	Fixed format	Full control

Dynamic Content

Use GitHub Actions expressions to inject data:


comment: |
  ## Deployment Complete
  
  **Environment:** ${{ github.event.inputs.environment }}
  **Version:** ${{ steps.version.outputs.tag }}
  **Deployed by:** @${{ github.actor }}
  
  [View Logs](${{ steps.deploy.outputs.logs_url }})

Markdown Support

Dev Herald supports all the markdown that GitHub does.