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

Automate rest api docs generation #4168

Merged
merged 5 commits into from
Aug 29, 2024
Merged

Automate rest api docs generation #4168

merged 5 commits into from
Aug 29, 2024

Conversation

nicpuppa
Copy link
Contributor

@nicpuppa nicpuppa commented Aug 17, 2024

This PR add a GH workflow to automate the creation of REST API specification in our documentation

@nicpuppa nicpuppa self-assigned this Aug 17, 2024
@nicpuppa nicpuppa force-pushed the sync-camunda-rest-api branch 8 times, most recently from 84f5737 to 0e0f8cc Compare August 17, 2024 14:00
@nicpuppa nicpuppa changed the title THIS IS A TEST (for now) Automate rest api docs generation Aug 19, 2024
@nicpuppa nicpuppa force-pushed the sync-camunda-rest-api branch 12 times, most recently from 112141c to 4a725bc Compare August 19, 2024 12:36
@nicpuppa nicpuppa force-pushed the sync-camunda-rest-api branch 8 times, most recently from 9ab8922 to c62a0a2 Compare August 26, 2024 15:38
@nicpuppa nicpuppa force-pushed the sync-camunda-rest-api branch 4 times, most recently from 3f0ff02 to 387f0b7 Compare August 26, 2024 17:18
@nicpuppa nicpuppa force-pushed the sync-camunda-rest-api branch from 387f0b7 to 86d5f79 Compare August 27, 2024 06:40
@nicpuppa nicpuppa requested review from akeller, pepopowitz, koevskinikola and megglos and removed request for koevskinikola August 27, 2024 06:40
@nicpuppa nicpuppa force-pushed the sync-camunda-rest-api branch from 86d5f79 to 0d3196f Compare August 27, 2024 06:42
@nicpuppa nicpuppa marked this pull request as ready for review August 27, 2024 06:42
.husky/pre-commit Outdated Show resolved Hide resolved
@nicpuppa nicpuppa requested a review from koevskinikola August 27, 2024 07:46
@akeller akeller added the dx Documentation infrastructure typically handled by the Camunda DX team label Aug 27, 2024
Copy link
Collaborator

@pepopowitz pepopowitz left a comment

Choose a reason for hiding this comment

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

I love this, and we (read: me, probably) should think about extending this to other APIs when possible.

I have some blocking feedback, especially around details of the PR that gets opened. I also started some conversations in my feedback, and we should not hesitate in those conversations to qualify things as worthy of follow-up PRs instead of blocking this one.

.github/workflows/sync-rest-api-docs.yaml Show resolved Hide resolved
.github/workflows/sync-rest-api-docs.yaml Show resolved Hide resolved
.github/workflows/sync-rest-api-docs.yaml Outdated Show resolved Hide resolved
.github/workflows/sync-rest-api-docs.yaml Outdated Show resolved Hide resolved
.github/workflows/sync-rest-api-docs.yaml Show resolved Hide resolved
The image used for our GH runners contains nvm,
likely we are using an older version of nvm not available in the runner
@nicpuppa nicpuppa requested a review from pepopowitz August 29, 2024 07:37
@nicpuppa
Copy link
Contributor Author

Hey @pepopowitz @akeller I addressed all the suggestions, please have another look 😄

@nicpuppa nicpuppa force-pushed the sync-camunda-rest-api branch from a61cbcd to 31d557c Compare August 29, 2024 07:42
Copy link
Collaborator

@pepopowitz pepopowitz left a comment

Choose a reason for hiding this comment

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

This looks great, thanks for making changes!!

Copy link
Member

@akeller akeller left a comment

Choose a reason for hiding this comment

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

👍 No complaints!

@nicpuppa nicpuppa merged commit 86911b9 into main Aug 29, 2024
7 checks passed
@nicpuppa nicpuppa deleted the sync-camunda-rest-api branch August 29, 2024 18:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dx Documentation infrastructure typically handled by the Camunda DX team
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants