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

Add docs generation workflow #282

Merged
merged 11 commits into from
Oct 11, 2023
Merged

Conversation

rolandkakonyi
Copy link
Contributor

@rolandkakonyi rolandkakonyi commented Oct 9, 2023

Description

This PR automates the API reference generation via GitHub Actions.

Changes

API Reference documentation is now auto-generated when a release is finished OR when manually triggered.
The results are uploaded by exact semver version like this and by major version like this.

Here is a successful run: https://github.com/bitmovin/bitmovin-player-react-native/actions/runs/6457805448/job/17530156205

Checklist

  • 🗒 CHANGELOG entry

@rolandkakonyi rolandkakonyi self-assigned this Oct 9, 2023
@rolandkakonyi rolandkakonyi force-pushed the add-docs-generation-workflow branch from ba2eb19 to 1ea8ab8 Compare October 9, 2023 14:17
@rolandkakonyi rolandkakonyi force-pushed the add-docs-generation-workflow branch from cf1da23 to d406a01 Compare October 9, 2023 14:35
@rolandkakonyi rolandkakonyi changed the base branch from api-docs to add-api-docs-generation-command October 9, 2023 14:48
@rolandkakonyi rolandkakonyi marked this pull request as ready for review October 10, 2023 13:56
Copy link
Contributor

@zigavehovec zigavehovec left a comment

Choose a reason for hiding this comment

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

Look good to me! Very nice improvement 👌

Base automatically changed from add-api-docs-generation-command to development October 11, 2023 09:35
@rolandkakonyi rolandkakonyi merged commit ebb7495 into development Oct 11, 2023
5 checks passed
@rolandkakonyi rolandkakonyi deleted the add-docs-generation-workflow branch October 11, 2023 20:05
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.

2 participants