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: Publish DocC documentation to GitHub pages #1478

Merged
merged 1 commit into from
Aug 30, 2024

Conversation

dpogue
Copy link
Member

@dpogue dpogue commented Aug 26, 2024

Actions-based publishing to GitHub Pages should now be enabled on this repo: https://issues.apache.org/jira/browse/INFRA-26070

Platforms affected

iOS

Motivation and Context

If we're adding docs to our CordovaLib public API, we might as well make them available online for people.

Description

Generates API documentation from the DocC code comments in CordovaLib, and publishes it to GitHub Pages.

Testing

Confirmed that this publishes correctly in my fork.

Co-Authored-By: Erisu <erisu@apache.org>
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.22%. Comparing base (458f5f3) to head (d8e3020).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1478   +/-   ##
=======================================
  Coverage   80.22%   80.22%           
=======================================
  Files          16       16           
  Lines        1871     1871           
=======================================
  Hits         1501     1501           
  Misses        370      370           

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

@dpogue dpogue added this to the 8.0.0 milestone Aug 29, 2024
@dpogue dpogue marked this pull request as ready for review August 29, 2024 16:38
Copy link
Member

@erisu erisu left a comment

Choose a reason for hiding this comment

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

LGTM

@erisu erisu merged commit adcc1fe into apache:master Aug 30, 2024
10 checks passed
@dpogue dpogue deleted the docc-publish branch August 30, 2024 08:00
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