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

ci: add examples to the CI/CD workflow #63

Closed
singla-shivam opened this issue Jun 26, 2022 · 0 comments · Fixed by #64
Closed

ci: add examples to the CI/CD workflow #63

singla-shivam opened this issue Jun 26, 2022 · 0 comments · Fixed by #64
Assignees
Labels
enhancement New feature or request

Comments

@singla-shivam
Copy link
Member

Is your feature request related to a problem? Please describe.

In the site, we have a feature Try on playground. For that to be implemented in the site, we were writing the example in the playground and writing the corresponding base64 string in the all.md file. This was posing mainly two problems-

  1. The file all.md was getting larger and larger. And the code was hard to change and it looked messy in the file
  2. There was no way to test the example against the latest version of Fae

Describe the solution you'd like

To solve the problem, we will be write the examples in the examples directory in Fae as Deno files only. They would import the latest version of Fae from Deno servers. Then, the website will fetch these examples files for a given function on demand. When the person clicks on the button Try on playground,

  1. the site server will fetch the file (if doesn't exists),
  2. will do appropriate sanitization on the imports,
  3. covert it to url-safe base64 and generate the playground url,
  4. and then redirects the developer to playground populated with the example for that function.

The functionality is already implemented in the website. See Jozty/website#29

In Fae, we will have checks on CI/CD pipelines to run all those examples against the latest version of Fae.

Additional context

Issues for adding examples in incremental manner- #59, #61

@singla-shivam singla-shivam added the enhancement New feature or request label Jun 26, 2022
@singla-shivam singla-shivam self-assigned this Jun 26, 2022
@singla-shivam singla-shivam linked a pull request Jun 27, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant