Workflow to publish phpdoc to github pages

[svrnm]

Follow-up to #1378 and #1385:

I did some investigation how to best publish the API documentation for PHP. Initially I was hoping that we can serve these pages through netlify (the service we use to publish opentelemetry.io), unfrotunately I ran into some limitations in my experiment, that I could not resolve, see: open-telemetry/opentelemetry.io#5413

Therefore I suggest to publish the pages to github via the workflow in this PR. This will create a page similar to

https://svrnm.github.io/opentelemetry-php/

(it will then be named https://open-telemetry.github.io/opentelemetry-php/)

We can then link this page from the website here: https://opentelemetry.io/docs/languages/#api-references and from within the navigation tree of the PHP language specific documentation.

Workflow run example:

https://github.com/svrnm/opentelemetry-php/actions/runs/11512969202/job/32048846572

cc @open-telemetry/docs-approvers

[netlify]

✅ Deploy Preview for opentelemetry-php canceled.

Name	Link
🔨 Latest commit	1b5a0b3
🔍 Latest deploy log	https://app.netlify.com/sites/opentelemetry-php/deploys/671b3b96504491000823112e

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.55%. Comparing base (93f2068) to head (1b5a0b3).
Report is 1 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #1418      +/-   ##
============================================
- Coverage     73.63%   73.55%   -0.08%     
  Complexity     2683     2683              
============================================
  Files           387      387              
  Lines          7975     7975              
============================================
- Hits           5872     5866       -6     
- Misses         2103     2109       +6     

Flag	Coverage Δ
8.1	73.24% <ø> (-0.14%)	⬇️
8.2	73.50% <ø> (+0.02%)	⬆️
8.3	73.42% <ø> (-0.05%)	⬇️
8.4	73.45% <ø> (-0.01%)	⬇️

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

see 9 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 93f2068...1b5a0b3. Read the comment docs.

[brettmc]

@svrnm merged. The workflow looks to have completed successfully, but I don't see any generated pages.... https://github.com/open-telemetry/opentelemetry-php/actions/runs/11543950343

[svrnm]

@brettmc have you enabled GitHub pages in the repo settings?

[brettmc]

@svrnm yes, and it indicates that something was deployed there. But now that I'm looking more closely at the job output it looks like we've got a competing job which might be publishing junk and clobbering the output you've created. I can't find any evidence in our repo of what that job might be or where it's defined though 🤔

[brettmc]

Oh, I think I found it. Pages are configured to auto-generate:

I'll turn that off and see what happens...

[brettmc]

I also notice now that the new workflow file doesn't have an extension. I think .yaml or .yml extension is required?

[svrnm]

Thanks for investigating what the issue is!

I also notice now that the new workflow file doesn't have an extension. I think .yaml or .yml extension is required?

Oh yes, my bad! The issue is that I had to test the workflow on the main branch of my fork so I copied and pasted the final version into a branch but forgot the .yml 🤦‍♂️