lee-dohm / view-rendered

Appends a "View Rendered" set of links to PRs that include Markdown documents

View Rendered

a GitHub App built with probot that appends a "View Rendered" set of links to PRs that include Markdown documents

Setup

# Install dependencies
npm install

# Run the bot
npm start

See docs/deploy.md if you would like to run your own instance of this app.

License

ISC

view-rendered's Issues

Move to @lee-dohm

Hey @lee-dohm, can we move this app to your account?

Make a nicer file label

Currently, the label of the rendered link is just the file path. It would be nice if it showed the "title" of the file by:

1. Checking to see if the first line of the Markdown file is a header. If so, use that as the file label
2. Humanize the filename (minus extension) by replacing hyphens or underscores with spaces and then titleizing the text

Use probot-attachments instead of hand-rolling our own

See https://github.com/probot/attachments

Update the links after the PR is merged or closed

View rendered links break because often when the PR is merged or closed, the branch is deleted. We should:

1. Update the links to point to the default branch when the PR is merged
2. Remove the view rendered section when the PR is closed