-
Notifications
You must be signed in to change notification settings - Fork 24
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
docs: add commit finder tutorial using Arrow library #597
Conversation
Signed-off-by: Ben Selwyn-Smith <benselwynsmith@googlemail.com>
Signed-off-by: Ben Selwyn-Smith <benselwynsmith@googlemail.com>
Thanks for the tutorial. Here are some of my comments:
The policy named You can then also the output of the
This should be better than telling the user to "copy and backup the HTML file because it will be overwritten by Macaron", which sounds like an inconvenience created on Macaron's side. Doing it this way also better demonstrates how Macaron is "supposed" to be used, to some extent at least. Having said that, I think you should still showcase the HTML reports because it adds some visual elements to the tutorial. |
Signed-off-by: Ben Selwyn-Smith <benselwynsmith@googlemail.com>
Signed-off-by: Ben Selwyn-Smith <benselwynsmith@googlemail.com>
Signed-off-by: Ben Selwyn-Smith <benselwynsmith@googlemail.com>
Signed-off-by: Ben Selwyn-Smith <benselwynsmith@googlemail.com>
Signed-off-by: Ben Selwyn-Smith <benselwynsmith@googlemail.com>
Signed-off-by: Ben Selwyn-Smith <benselwynsmith@googlemail.com>
Signed-off-by: Ben Selwyn-Smith <benselwynsmith@googlemail.com>
This PR adds a new tutorial demonstrating the capabilities and usage of the commit finder feature. It highlights how Macaron can report on differences between two versions of the same artifact by analysing the repository's related states. The Arrow Python library is used as a demonstration project.
Closes #500