Skip to content

enhanced smoke test and example usage#378

Merged
ericbuckley merged 6 commits into
mainfrom
doc/enhanced-smoke-test-and-example-usage
May 19, 2025
Merged

enhanced smoke test and example usage#378
ericbuckley merged 6 commits into
mainfrom
doc/enhanced-smoke-test-and-example-usage

Conversation

@ericbuckley

@ericbuckley ericbuckley commented May 16, 2025 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Description

Scripting and enhancing (adding more steps to test API endpoints) the smoke test suite so its easy to run locally. Also adding documentation to the site docs to give users an overview of how the API can be used.

Related Issues

closes #140

<--------------------- REMOVE THE LINES BELOW BEFORE MERGING --------------------->

Checklist

Please review and complete the following checklist before submitting your pull request:

  • I have ensured that the pull request is of a manageable size, allowing it to be reviewed within a single session.
  • I have reviewed my changes to ensure they are clear, concise, and well-documented.
  • I have updated the documentation, if applicable.
  • I have added or updated test cases to cover my changes, if applicable.
  • I have minimized the number of reviewers to include only those essential for the review.

Checklist for Reviewers

Please review and complete the following checklist during the review process:

  • The code follows best practices and conventions.
  • The changes implement the desired functionality or fix the reported issue.
  • The tests cover the new changes and pass successfully.
  • Any potential edge cases or error scenarios have been considered.

@ericbuckley ericbuckley self-assigned this May 16, 2025
@ericbuckley ericbuckley added documentation Improvements or additions to documentation automation Automation of processes labels May 16, 2025
@codecov

codecov Bot commented May 16, 2025 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.51%. Comparing base (210f706) to head (036fba3).
Report is 2 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #378   +/-   ##
=======================================
  Coverage   98.51%   98.51%           
=======================================
  Files          33       33           
  Lines        1948     1948           
=======================================
  Hits         1919     1919           
  Misses         29       29

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ericbuckley ericbuckley marked this pull request as ready for review May 17, 2025 16:06
m-goggins
m-goggins approved these changes May 19, 2025
View reviewed changes

@m-goggins m-goggins left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks great!

@ericbuckley ericbuckley merged commit ca5ac55 into main May 19, 2025
16 checks passed
@ericbuckley ericbuckley deleted the doc/enhanced-smoke-test-and-example-usage branch May 19, 2025 15:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@m-goggins m-goggins m-goggins approved these changes

@bamader bamader Awaiting requested review from bamader bamader is a code owner

@johanna-skylight johanna-skylight Awaiting requested review from johanna-skylight

Assignees

@ericbuckley ericbuckley

Labels

automation Automation of processes documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

smoke test enhancements

2 participants

@ericbuckley @m-goggins