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

chore: migrate to reusable ref docs gh action #152

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

OmarAlJarrah
Copy link
Contributor

@OmarAlJarrah OmarAlJarrah commented Jan 12, 2025

Situation

At the moment of creating this pull request, we use the GitHub action generate-reference-docs.yaml to generate docs. The action has a duplicate in rapid-java-sdk/.github/workflows/generate-docs-site.yml.

Task

With the newly proposed reusable action in the expediagroup-java-sdk repository, specifically in the pr [933] chore: add reusable generate reference docs action, different product repositories can use a central GitHub action for generating and deploying reference docs.

Delete the already existing generate-reference-docs.yaml action and consume the new action in expediagroup-java-sdk.

Action

Deleted the already existing action and modified it to consume the new action.

Testing

Results

We now consume the new centralized action.

Notes

Should not be merged before:

Comment on lines -5 to -10
inputs:
ref:
description: 'Choose the branch/tag/ref to deploy the reference documentation from'
required: true
default: 'main'
type: string
Copy link
Member

Choose a reason for hiding this comment

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

Let's keep this option available.

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