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

[POC] Interactive cookbooks + automated testing #306

Closed
wants to merge 131 commits into from
Closed

Conversation

mnkiefer
Copy link
Contributor

@mnkiefer mnkiefer commented Jul 17, 2023

  • Adds interactive cookbook feature to external Capire repo in order to:

    • Enable notebook generation of CAP Notebooks in pipeline
    • Run automated testing on them to sanitise CAP cookbook content
  • We already have several notebooks enabled, which are now checked and sanitised:

    • Hello, World (Node.js)
    • Hello, World (Java)
    • Getting started in a Nutshell (Node.js)
    • Getting started in a Nutshell (Java)

@mnkiefer mnkiefer marked this pull request as draft July 17, 2023 12:03
@mnkiefer mnkiefer changed the title Add interactive cookbooks Interactive cookbooks + automated testing Jul 17, 2023
@cap-js cap-js deleted a comment from github-actions bot Jul 17, 2023
@mnkiefer mnkiefer marked this pull request as ready for review July 17, 2023 17:02
@mnkiefer mnkiefer requested a review from chgeo July 17, 2023 17:02
Copy link
Member

@chgeo chgeo left a comment

Choose a reason for hiding this comment

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

Looks good to me

.github/notebooks/html2capnb.cjs Show resolved Hide resolved
@chgeo
Copy link
Member

chgeo commented Jul 18, 2023

Can we do a test and make one of the notebooks fail, so that I can see a test error?

@mnkiefer
Copy link
Contributor Author

Can we do a test and make one of the notebooks fail, so that I can see a test error?

I induced an error just now (cds init -> cds innit) in the Node.js Getting started guide so you can see what it looks like.

@renejeglinsky
Copy link
Contributor

💥 Broken cookbooks found!

Go to test summary

The link is dead. Should be cap-js instead of cap.
I wouldn't have caught from the output what the error is. Did I just not see it (absolutely possible!)?

@cap-js cap-js deleted a comment from github-actions bot Jul 18, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jul 18, 2023

💥 Broken Notebooks found!

@mnkiefer
Copy link
Contributor Author

💥 Broken cookbooks found!
Go to test summary

The link is dead. Should be cap-js instead of cap. I wouldn't have caught from the output what the error is. Did I just not see it (absolutely possible!)?

You're right! It was still using the internal link (with GHES). I just fixed it, you should now be able to navigate to the GHA summary and see the failed Notebook result. 👍

@chgeo
Copy link
Member

chgeo commented Jul 18, 2023

Looks good!

@mnkiefer mnkiefer enabled auto-merge (squash) July 19, 2023 17:48
@mnkiefer mnkiefer disabled auto-merge July 19, 2023 18:08
@mnkiefer mnkiefer changed the title Interactive cookbooks + automated testing [POC] Interactive cookbooks + automated testing Mar 13, 2024
@mnkiefer
Copy link
Contributor Author

Done testing

@mnkiefer mnkiefer closed this Mar 13, 2024
@mnkiefer mnkiefer deleted the addNotebooks branch April 15, 2024 13:28
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.

3 participants