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

Enable AppVeyor artifact comments in pull requests #119

Closed
agitter opened this issue Mar 30, 2020 · 4 comments
Closed

Enable AppVeyor artifact comments in pull requests #119

agitter opened this issue Mar 30, 2020 · 4 comments

Comments

@agitter
Copy link
Collaborator

agitter commented Mar 30, 2020

Is your feature request related to a problem? Please describe.
Viewing manuscript artifacts through GitHub Actions is somewhat cumbersome.

Describe the solution you'd like
AppVeyor can comment on a pull request after the manuscript builds, directly linking to the HTML and PDF artifacts. See greenelab/deep-review#997 (comment) for an example.

Describe alternatives you've considered
I attempted to implement a similar feature with GitHub Actions comments upstream in rootstock. It isn't currently possible for reasons detailed in manubot/rootstock#327

Additional context
The project leads would need to evaluate the tradeoffs of having manuscript artifacts more easily accessible during review versus the additional notifications generated. AppVeyor's pull request comments trigger a notification every time the artifact is posted. I don't mind that, but some people do.

@rando2
Copy link
Collaborator

rando2 commented Apr 1, 2020

Hi @agitter , sorry for my slow response on this issue. For this project especially, I think user-friendliness is a priority, even if it generates more notifications. If this is something you are able to implement, I think it would be helpful for this project and potentially might serve to pique more people's interest in manubot.

@agitter
Copy link
Collaborator Author

agitter commented Apr 1, 2020

The .appveyor.yml config file is already in the repository. Someone from @greenelab with the appropriate credentials should be able to enable AppVeyor builds by following the rootstock setup instructions

You can optionally enable AppVeyor continuous integration to view pull request builds. Unlike Travis CI, AppVeyor supports storing manuscripts generated during pull request builds as artifacts. These can be previewed to facilitate pull request review and ensure formatting and reference changes render as expected. When a pull request build runs successfully, @AppVeyorBot will comment on the pull request with a download link to the manuscript PDF.

To enable AppVeyor, follow steps 1 and 2 of the AppVeyor welcome to sign in to AppVeyor and add your manuscript repository as an AppVeyor project. The repository already contains an .appveyor.yml build configuration file, so no other setup is required. AppVeyor only runs when it detects changes that are likely to affect the manuscript.

@cgreene
Copy link
Member

cgreene commented Apr 2, 2020

I think I have done this.

We can check the status of this when it finishes: https://ci.appveyor.com/project/cgreene/covid19-review/builds/31903395

@agitter
Copy link
Collaborator Author

agitter commented Apr 2, 2020

Thanks @cgreene. It worked in #122.

@agitter agitter closed this as completed Apr 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants