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

feat(spec): commit bundled specs #134

Merged
merged 6 commits into from
Feb 14, 2022
Merged

Conversation

shortcuts
Copy link
Member

@shortcuts shortcuts commented Feb 11, 2022

🧭 What and Why

🎟 JIRA Ticket: https://algolia.atlassian.net/browse/APIC-288

As we recommend/require to write specs with a precise schema (which makes the navigation easier when you are familiar with it), it makes the collaboration harder with external team that needs to dig into the repo.

We now push bundled specs (dist folder) in order to ease external collaboration, but it is also required when generating the documentation: #92.

Changes included:

  • Pushes bundled specs to the repository.
  • Remove caching specs, we now only check that the bundled specs are the same as the pushed ones.

Questions:

If you have any suggestions to make it more explicit that those are generated and should not be edited, please submit them.

🧪 Test

CI :D

@shortcuts shortcuts requested a review from millotp February 11, 2022 09:59
@shortcuts shortcuts self-assigned this Feb 11, 2022
millotp
millotp previously approved these changes Feb 11, 2022
specs/dist/README.md Outdated Show resolved Hide resolved
@shortcuts shortcuts requested a review from millotp February 11, 2022 15:55
@shortcuts shortcuts enabled auto-merge (squash) February 11, 2022 15:55
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