-
Notifications
You must be signed in to change notification settings - Fork 6
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
maint: add dev notes and update smoke test #28
Conversation
* Add dedicated DEVELOPING.md for local dev setup and notes, and reference that section in the README. Also update links in README. * Console output is needed for smoke test, but DiagConsoleLogger doesn't seem to be logging as expected, maybe because of the bundler? So for smoke tests right now, use ConsoleSpanExporter. * Sometimes the console output takes longer than the default timeout of 4000ms, so update Cypress config to timeout at 10000ms instead.
DEVELOPING.md
Outdated
# start example app | ||
npm start | ||
|
||
# after PR 26 |
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.
If #26 merges first I can update this, otherwise I can come back to this... but wanted to note it while I'm here!
@@ -1,6 +1,7 @@ | |||
import { defineConfig } from 'cypress'; | |||
|
|||
export default defineConfig({ | |||
defaultCommandTimeout: 10000, // default is 4000 |
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.
When running the smoke tests locally the tests would fail with a timeout, so I picked an arbitrary number for now and it's been more reliable
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.
All instructions so far worked for me locally! Thanks
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.
glorious! 🚀
just needed to enable Verbose level in the console. Removing the console span exporter
Which problem is this PR solving?
Short description of the changes
DEVELOPING.md
for local dev setup and notes, and reference that section in the README. Also update links in README for other docs.How to verify that this has the expected result
Following any of the steps in the DEVELOPING doc work, including the smoke tests.