ci: API reference documentation not generated

parse-community / Parse-SDK-iOS-OSX

The Apple SDK for Parse Platform (iOS, macOS, watchOS, tvOS)

https://parseplatform.org

Other

2.81k stars 865 forks source link

ci: API reference documentation not generated #1718

Closed dplewis closed 1 year ago

dplewis commented 1 year ago

New Pull Request Checklist

[ ] I am not disclosing a vulnerability.
[ ] I am creating this PR in reference to an issue.

Issue Description

Parse.h header file was moved in https://github.com/parse-community/Parse-SDK-iOS-OSX/pull/1683 preventing the api documentation from generating.

error: error reading '/Users/runner/work/Parse-SDK-iOS-OSX/Parse-SDK-iOS-OSX/Parse/Parse/Parse.h'

Closes: https://github.com/parse-community/Parse-SDK-iOS-OSX/issues/1702

Approach

Allow jazzy script to fail with non-zero exit code
Correct the proper header path

parse-github-assistant[bot] commented 1 year ago

Thanks for opening this pull request!

🎉 We are excited about your hands-on contribution!

dplewis commented 1 year ago

This is ready to merge

mtrezza commented 1 year ago

The workfow was successful, but the pages were not published. http://parseplatform.org/Parse-SDK-iOS-OSX/api/ still leads to a 404 page.

dplewis commented 1 year ago

They won’t be published until the next release hopefully

mtrezza commented 1 year ago

I triggered the manual docs workflow and it didn't work. But maybe because there's no difference in the API, so the manual trigger doesn't actually work.

dplewis commented 1 year ago

The manual docs workflow itself has errors and can't generate the docs. Look at the CI closely. It looks like it passes but its actually failing.

mtrezza commented 1 year ago

Should we try to get the manual workflow working, so we know that with the next release it will work automatically?

parseplatformorg commented 1 year ago

🎉 This change has been released in version 2.2.0