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

Create a workflow to deploy the Dokka documentation #775

Merged
merged 2 commits into from
Oct 31, 2024
Merged

Conversation

MGaetan89
Copy link
Member

@MGaetan89 MGaetan89 commented Oct 29, 2024

Pull request

Description

Create a new workflow to generate and deploy the Dokka documentation.

Merging this will unblock #770 (comment), as we will be able to put actual links in the Readme file.

Changes made

Note

For now, it is triggered on every push on main. Once the whole documentation is complete, I suggest triggering it only for each new release (or merging it with the release.yml workflow).

Checklist

  • APIs have been properly documented (if relevant).
  • The documentation has been updated (if relevant).
  • New unit tests have been written (if relevant).
  • The demo has been updated (if relevant).

@MGaetan89 MGaetan89 self-assigned this Oct 29, 2024
Copy link

github-actions bot commented Oct 29, 2024

Code Coverage

Overall Project 47.79% 🟢
Module Coverage
Kover Gradle Plugin XML report for :plugins 7.57% 🟢
Files
Module File Coverage
Kover Gradle Plugin XML report for :plugins PillarboxAndroidLibraryPublishingPlugin.kt 0% 🟢

@MGaetan89 MGaetan89 marked this pull request as ready for review October 29, 2024 15:50
@MGaetan89 MGaetan89 requested a review from StaehliJ October 29, 2024 15:50
@MGaetan89 MGaetan89 changed the title Create a workflow to deploy the javadoc Create a workflow to deploy the Dokka documentation Oct 29, 2024
@MGaetan89 MGaetan89 added this pull request to the merge queue Oct 31, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 31, 2024
@MGaetan89 MGaetan89 added this pull request to the merge queue Oct 31, 2024
Merged via the queue into main with commit 1aef6eb Oct 31, 2024
14 of 15 checks passed
@MGaetan89 MGaetan89 deleted the deploy_javadoc branch October 31, 2024 11:22
@MGaetan89 MGaetan89 linked an issue Oct 31, 2024 that may be closed by this pull request
@MGaetan89 MGaetan89 added the documentation Improvements or additions to documentation label Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Provide a consolidated documentation for Pillarbox
2 participants