Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MER-2418] Make it easy to detect a PR markdown #165

Merged
merged 1 commit into from
Jun 6, 2023
Merged

Conversation

draftcode
Copy link
Contributor

@draftcode draftcode commented Jun 6, 2023

This is a nice to have and a harmless change. The temp file created for
the pull-request title and body now has an extension '.av.md'. This is
anyway recognized as a markdown file for most of the editors, but this
extra 'av' extension allows us to have a special file type that supports
'%%' as a comment.

As an example, added a Vim plugin that recognize this file type and
treats '%%' as a comment.

@aviator-app
Copy link
Contributor

aviator-app bot commented Jun 6, 2023

Current Aviator status

Aviator will automatically update this comment as the status of the PR changes.
Comment /aviator refresh to force Aviator to re-examine your PR (or learn about other /aviator commands).

This PR was merged using Aviator.


See the real-time status of this PR on the Aviator webapp.

@draftcode draftcode force-pushed the av-markdown branch 2 times, most recently from d5c6c61 to 24d9b56 Compare June 6, 2023 18:39
@draftcode draftcode changed the title feat: Make it easy to detect a PR markdown [MER-2418] Make it easy to detect a PR markdown Jun 6, 2023
@draftcode
Copy link
Contributor Author

This makes Vim render the PR body like this:

image

@draftcode
Copy link
Contributor Author

I'm fine with excluding the Vim plugin part. I can keep it local. But the PR temp file change is anyway harmless.

Copy link
Contributor

@jainankit jainankit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great. We should also document this - suggest that folks can use the vim plugin or build their own for their IDE (i future we can do a VS code plugin for this).

@twavv
Copy link
Contributor

twavv commented Jun 6, 2023

I wonder if it's possible to include these as extra files installed by (e.g.,) the brew cask.

@draftcode
Copy link
Contributor Author

I wonder if it's possible to include these as extra files installed by (e.g.,) the brew cask.

It's probably a bit difficult. But since Vim has relatively established plugin install system now, I think it's easy to distribute this as a Vim plugin (by moving these files to another repo).

This is a nice to have and a harmless change. The temp file created for
the pull-request title and body now has an extension '.av.md'. This is
anyway recognized as a markdown file for most of the editors, but this
extra 'av' extension allows us to have a special file type that supports
'%%' as a comment.

As an example, added a Vim plugin that recognize this file type and
treats '%%' as a comment.
@aviator-app aviator-app bot merged commit d1fd148 into master Jun 6, 2023
@aviator-app aviator-app bot deleted the av-markdown branch June 6, 2023 20:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants