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

fix(clients): add generation banner to generated files #816

Merged
merged 3 commits into from
Jul 12, 2022

Conversation

shortcuts
Copy link
Member

🧭 What and Why

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

Changes included:

Sets the generation notice banner at the top of every files, feel free to recommend a better syntax/sentence.

🧪 Test

Generated code :D

@shortcuts shortcuts requested a review from a team July 12, 2022 13:20
@shortcuts shortcuts self-assigned this Jul 12, 2022
@shortcuts shortcuts requested review from damcou and millotp and removed request for a team July 12, 2022 13:20
@netlify
Copy link

netlify bot commented Jul 12, 2022

Deploy Preview for api-clients-automation ready!

Name Link
🔨 Latest commit 3168d4b
🔍 Latest deploy log https://app.netlify.com/sites/api-clients-automation/deploys/62cd85cad21ecb000924a737
😎 Deploy Preview https://deploy-preview-816--api-clients-automation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@algolia-bot
Copy link
Collaborator

algolia-bot commented Jul 12, 2022

✗ The generated branch has been deleted.

If the PR has been merged, you can check the generated code on the main branch.
You can still access the code generated on main via this commit.

Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

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

Nice !

website/docs/contributing/add-new-language.md Outdated Show resolved Hide resolved

The banner **should** be added at the very top of every generated files, to avoid confusion for our user, but also redirect them to the `api-clients-automation` monorepo, where the contribution happens.

To do so, a `generationBanner` variable is available on every `mustache` templates, see [the initial implementation](https://github.com/algolia/api-clients-automation/pull/816) for more context.
Copy link
Collaborator

Choose a reason for hiding this comment

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

recursion 🤯

damcou
damcou previously approved these changes Jul 12, 2022
website/docs/contributing/add-new-language.md Outdated Show resolved Hide resolved
@shortcuts shortcuts merged commit 4b55738 into main Jul 12, 2022
@shortcuts shortcuts deleted the fix/add-generation-banner branch July 12, 2022 15:11
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.

4 participants