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

Docs update for local dev #5134

Merged
merged 5 commits into from
Jun 11, 2021
Merged

Conversation

ddragosd
Copy link
Contributor

I've recently configured a new Mac and I've taken the chance to use more recent libs. After successfully running OW locally, I've updated the docs with the versions.

I've also included a section detailing how to run unit tests locally.

Description

Related issue and scope

  • I opened an issue to propose and discuss this change (#????)

My changes affect the following components

  • API
  • Controller
  • Message Bus (e.g., Kafka)
  • Loadbalancer
  • Scheduler
  • Invoker
  • Intrinsic actions (e.g., sequences, conductors)
  • Data stores (e.g., CouchDB)
  • Tests
  • Deployment
  • CLI
  • General tooling
  • Documentation

Types of changes

  • Bug fix (generally a non-breaking change which closes an issue).
  • Enhancement or new feature (adds new functionality).
  • Breaking change (a bug fix or enhancement which changes existing behavior).

Checklist:

  • I signed an Apache CLA.
  • I reviewed the style guides and followed the recommendations (Travis CI will check :).
  • I added tests to cover my changes.
  • My changes require further changes to the documentation.
  • I updated the documentation where necessary.

@codecov-commenter
Copy link

codecov-commenter commented Jun 11, 2021

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.78%. Comparing base (58b2183) to head (d24ce33).
Report is 186 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##           master    #5134       +/-   ##
===========================================
+ Coverage   42.68%   74.78%   +32.09%     
===========================================
  Files         233      233               
  Lines       12661    12661               
  Branches      521      521               
===========================================
+ Hits         5404     9468     +4064     
+ Misses       7257     3193     -4064     

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

Copy link
Member

@dgrove-oss dgrove-oss left a comment

Choose a reason for hiding this comment

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

Thanks for doing this! Definitely needed a refresh

@ddragosd ddragosd merged commit afe3986 into apache:master Jun 11, 2021
@ddragosd ddragosd deleted the doc_update_jun_2021 branch June 11, 2021 22:12
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.

3 participants