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

ci: API reference documentation not generated #1718

Merged
merged 3 commits into from
Mar 7, 2023

Conversation

dplewis
Copy link
Member

@dplewis dplewis commented Mar 6, 2023

New Pull Request Checklist

Issue Description

Parse.h header file was moved in #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: #1702

Approach

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

@parse-github-assistant
Copy link

parse-github-assistant bot commented Mar 6, 2023

Thanks for opening this pull request!

  • 🎉 We are excited about your hands-on contribution!

@dplewis dplewis requested a review from mtrezza March 6, 2023 19:48
Copy link
Member

@mtrezza mtrezza left a comment

Choose a reason for hiding this comment

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

Thanks a lot for this! Is this ready for merge?

@mtrezza mtrezza changed the title fix: Generate API Reference Documentation docs: API reference documentation not generated Mar 7, 2023
@mtrezza mtrezza changed the title docs: API reference documentation not generated ci: API reference documentation not generated Mar 7, 2023
@dplewis
Copy link
Member Author

dplewis commented Mar 7, 2023

This is ready to merge

@mtrezza mtrezza merged commit 28b9b80 into parse-community:master Mar 7, 2023
@mtrezza
Copy link
Member

mtrezza commented Mar 7, 2023

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 dplewis deleted the fix-api-docs branch March 7, 2023 16:14
@dplewis
Copy link
Member Author

dplewis commented Mar 7, 2023

They won’t be published until the next release hopefully

@mtrezza
Copy link
Member

mtrezza commented Mar 7, 2023

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
Copy link
Member Author

dplewis commented Mar 7, 2023

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.

Screen Shot 2023-03-07 at 12 06 02 PM

@mtrezza
Copy link
Member

mtrezza commented Mar 7, 2023

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

@parseplatformorg
Copy link
Contributor

🎉 This change has been released in version 2.2.0

@parseplatformorg parseplatformorg added the state:released Released as stable version label Mar 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
state:released Released as stable version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

API docs publishing fails on release
3 participants