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

add phpDocumentor instructions to Makefile #1385

Merged
merged 2 commits into from
Sep 25, 2024

Conversation

svrnm
Copy link
Member

@svrnm svrnm commented Sep 24, 2024

fixes #1378:

  • Introduce 2 new instructions in the Makefile to generate API documentation and to preview the documentation
  • Adds a docker compose file that provides the runner and preview service
  • Add a basic configuration file for phpdoc
  • Add instructions to DEVELOPMENT.md on how to use these additional commands

@svrnm svrnm requested a review from a team as a code owner September 24, 2024 08:57
Copy link

welcome bot commented Sep 24, 2024

Thanks for opening your first pull request! If you haven't yet signed our Contributor License Agreement (CLA), then please do so that we can accept your contribution. A link should appear shortly in this PR if you have not already signed one.

Copy link

codecov bot commented Sep 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.09%. Comparing base (8ed62b1) to head (0dbb7ce).
Report is 5 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff              @@
##               main    #1385      +/-   ##
============================================
+ Coverage     73.98%   74.09%   +0.10%     
  Complexity     2666     2666              
============================================
  Files           385      385              
  Lines          7638     7638              
============================================
+ Hits           5651     5659       +8     
+ Misses         1987     1979       -8     
Flag Coverage Δ
8.1 73.69% <ø> (+0.01%) ⬆️
8.2 73.89% <ø> (-0.06%) ⬇️
8.3 73.98% <ø> (+0.07%) ⬆️
8.4 73.98% <ø> (+0.04%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 3 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8ed62b1...0dbb7ce. Read the comment docs.

@bobstrecansky bobstrecansky merged commit 91f4735 into open-telemetry:main Sep 25, 2024
10 checks passed
brettmc pushed a commit to brettmc/opentelemetry-php that referenced this pull request Oct 2, 2024
* add phpDocumentor instructions to Makefile

Signed-off-by: svrnm <[email protected]>

* update DEVELOPMENT.md

Signed-off-by: svrnm <[email protected]>

---------

Signed-off-by: svrnm <[email protected]>
bobstrecansky pushed a commit that referenced this pull request Oct 2, 2024
* 8.4: fixing some implicit nullable params

* fix withspan handler nullable + example (#1377)

- class is nullable for pre hooks
- add phpt tests for withspan and its interaction with auto root span

* fix: update references to logging exporter (#1383)

This exporter has been replaced by the debug exporter and will be removed soon. Related to open-telemetry/opentelemetry-collector#11037

Signed-off-by: Alex Boten <[email protected]>

* fix: Update collector tag in example to latest (#1384)

Follow-up from #1383. Debug exporter isn't available until v0.86.0, so this new configuration throws an error when trying to run the collector. `Error: cannot unmarshal the configuration: unknown exporters type "debug" for "debug"` Instead of setting to v0.86.0, I noticed the other docker files omitted the tag (so latest is pulled). I just updated this to match.

* Remove `MeterInterface::isEnabled()` and fix meter config re-enabling (#1387)

* Update SPI dependency to v1. (#1388)

* Fix README badges. (#1389)

* add phpDocumentor instructions to Makefile (#1385)

* add phpDocumentor instructions to Makefile

Signed-off-by: svrnm <[email protected]>

* update DEVELOPMENT.md

Signed-off-by: svrnm <[email protected]>

---------

Signed-off-by: svrnm <[email protected]>

* Update README.md (#1344)

* Fix `IncompatibleReturnValueException` in `MessageFactoryTest` (#1392)

PSR7 `RequestInterface::getUri()` must return `UriInterface`, not `string`; explicit typehint was added in `2.0`.

* more implicit nulls

---------

Signed-off-by: Alex Boten <[email protected]>
Signed-off-by: svrnm <[email protected]>
Co-authored-by: Alex Boten <[email protected]>
Co-authored-by: Jamie Danielson <[email protected]>
Co-authored-by: Tobias Bachert <[email protected]>
Co-authored-by: Chris Lightfoot-Wild <[email protected]>
Co-authored-by: Severin Neumann <[email protected]>
Co-authored-by: Oleg <[email protected]>
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.

Publish API Documentation
2 participants