Skip to content

feat: upgrade redocly action #81

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

Merged
merged 11 commits into from
Jul 14, 2025
Merged

feat: upgrade redocly action #81

merged 11 commits into from
Jul 14, 2025

Conversation

Jiloc
Copy link
Contributor

@Jiloc Jiloc commented Jul 8, 2025

Use the following template to create your pull request

Description

This PR removes the deprecated seeebiii/redoc-cli-github-action in favor of directly using an updated version of redocly-cli.
It also add new parameters to enable validation of the OpenAPI spec, and the relative documentation in the README.

I temporarily pointed stacks-network/stacks-core#6227 to the action in this branch and it properly validated the docs, generated and uploaded the artifacts!

here is the CI workflow result: https://github.com/stacks-network/stacks-core/actions/runs/16148998367/job/45576255836?pr=6201
here is the uploaded artifact: https://github.com/stacks-network/stacks-core/actions/runs/16148998367/artifacts/3488232942

@Jiloc Jiloc requested review from wileyj and BowTiedDevOps July 8, 2025 16:40
@Jiloc Jiloc self-assigned this Jul 8, 2025
@Jiloc Jiloc moved this to Status: In Review in Stacks Core Eng Jul 8, 2025
@Jiloc Jiloc requested a review from wileyj July 9, 2025 12:33
@wileyj
Copy link
Collaborator

wileyj commented Jul 9, 2025

Looks great!
only blocker to merge is checking this won't break existing openapi validation (simple enough to test), but otherwise it looks ready

Copy link
Collaborator

@wileyj wileyj left a comment

Choose a reason for hiding this comment

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

tested both scenarios, looks good!

@github-project-automation github-project-automation bot moved this from Status: In Review to Status: 💻 In Progress in Stacks Core Eng Jul 14, 2025
@wileyj wileyj merged commit 2cd354b into main Jul 14, 2025
1 check passed
@github-project-automation github-project-automation bot moved this from Status: 💻 In Progress to Status: ✅ Done in Stacks Core Eng Jul 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants