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

Check that PRs do not break Asciidoctor build #251

Merged
merged 1 commit into from
Mar 31, 2020
Merged

Check that PRs do not break Asciidoctor build #251

merged 1 commit into from
Mar 31, 2020

Conversation

lesserwhirls
Copy link
Contributor

This PR enables a github action to check that PRs do not break the asciidoc build. If the build is successful, the pdf and html files are uploaded as artifacts to the action, which allow for easier previews of the generated files.

@lesserwhirls
Copy link
Contributor Author

As an example of what this will look like, see here.

@marqh
Copy link
Member

marqh commented Mar 19, 2020

I agree this is a useful and sensible step

thank you for the input @lesserwhirls

Copy link
Member

@marqh marqh left a comment

Choose a reason for hiding this comment

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

This looks well set up to me

@lesserwhirls
Copy link
Contributor Author

Thanks @marqh! Happy to help where I can :-)

@zklaus
Copy link

zklaus commented Mar 23, 2020

This is great!
Would it be possible to upload the pdf and html individually, not in an archive so as to facilitate easy inspection?
Maybe it would also be a good idea to upload a log (perhaps just the console output)?
Like this, we might catch some warnings more easily that don't prevent a successful creation, but would be nice to know anyways.

This PR enables a github action to check that PRs do not break the
asciidoc build. If the build is successful, the pdf and html files are
uploaded as artifacts to the action, which allow for easier previews of
the generated files.
@lesserwhirls
Copy link
Contributor Author

This is great!
Would it be possible to upload the pdf and html individually, not in an archive so as to facilitate easy inspection?

That would be great! Currently, the actions/upload-artifact github action does not support it, but it's on their list of improvements (more info here).

Maybe it would also be a good idea to upload a log (perhaps just the console output)?
Like this, we might catch some warnings more easily that don't prevent a successful creation, but would be nice to know anyways.

I've updated this PR to enable the asciidoctor build to use the --verbose flag, which seems to show warnings. An example of what the output looks like now can be found here.

@ethanrd
Copy link
Member

ethanrd commented Mar 31, 2020

Two positive reviews and it looks good to me. I'm going to merge.

I will look at how to require reviews for this type of PR, probably by members of the info-mgmt team - @cf-convention/info-mgmt

@ethanrd ethanrd merged commit 1ad15c6 into cf-convention:master Mar 31, 2020
@lesserwhirls lesserwhirls deleted the pr-build-check branch June 4, 2020 20:16
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

Successfully merging this pull request may close these issues.

4 participants