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

[MAINT] Make github workflow format openapi.json #879

Merged

Conversation

peytondmurray
Copy link
Contributor

@peytondmurray peytondmurray commented Sep 13, 2024

Fixes #870.

Description

This pull request runs jq to format the generated openapi.json in a more human readable format. This also inserts a newline at the end of the file so that pre-commit.ci stops failing on all PRs.

I've also made jq sort the json by keys, which should make the order nice and stable.

Pull request checklist

  • Did you test this change locally?
  • Did you update the documentation (if required)?
  • Did you add/update relevant tests for this change (if required)?

Copy link

netlify bot commented Sep 13, 2024

Deploy Preview for conda-store canceled.

Name Link
🔨 Latest commit f52f775
🔍 Latest deploy log https://app.netlify.com/sites/conda-store/deploys/66e9a6df527b340008bdef82

@peytondmurray peytondmurray marked this pull request as ready for review September 13, 2024 18:45
Copy link
Collaborator

@trallard trallard left a comment

Choose a reason for hiding this comment

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

Small nit (non blocking) so will go ahead and approve and let you to merge when you see fit @peytondmurray

.github/workflows/generate_api_docs.yaml Outdated Show resolved Hide resolved
@peytondmurray peytondmurray merged commit 6da65e6 into conda-incubator:main Sep 17, 2024
27 checks passed
@peytondmurray peytondmurray deleted the 870-format-openapi-json branch September 17, 2024 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: api 🌐 area: documentation 📖 Improvements or additions to documentation area: github actions Pull requests that update GitHub Actions code type: maintenance 🛠
Projects
Status: Done 💪🏾
Development

Successfully merging this pull request may close these issues.

[ENH] - unformatted openapi.json makes it really hard to review changes
2 participants