-
Notifications
You must be signed in to change notification settings - Fork 2
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
Prepare second docs artifact, for human consumption #12
Conversation
Pull Request Test Coverage Report for Build 10777419036Details
💛 - Coveralls |
Is this really needed? You can just as easily get the |
I mentioned this in the update, above. You might not have seen that if you read only the email notification. That artifact has a generic name and extracts into a tar file which then can be extracted into the current directory. The artifact for humans has an intentional name and extracts into a subdirectory. It's meant to be more convenient to work with. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I indeed overlooked your updated description.
I still do not see a pressing need for this, but it does not harm 👍
(cherry picked from commit d9e0926)
(cherry picked from commit d9e0926) Co-authored-by: Jim Garrison <[email protected]>
This is what it would look like if we were to generate a second docs artifact, meant for human consumption. The reason we might want to do this because some of us (me) will be more likely to download and look at a docs preview if the artifact is nicer to work with. The reason we might not want to do this is because it adds lines to our CI configuration.
Follow-up to #5 (comment) and #8.
UPDATE: actually, after trying to work with the github-pages artifact, I am much in favor of this. Working with that one basically involves
while this artifact for humans can be extracted easily anywhere using
unzip
without causing much harm (everything in a single subdirectory with the same name).