Migrate Demo from AWS Lightsail to GitPages

[rashidakanchwala]

Description

Migration of Demo Project from AWS to GitHub Pages

Rationale for Migration:

• Cost: AWS is expensive.
• Compliance: The internal AWS account requires us to meet McK Infosec requirements.

Challenges with Migration:

We couldn't migrate earlier because static hosting worked for the flowchart but not for experiment tracking.

Updates in This PR:

• Generated all static JSON files needed for experiment tracking (47/50 file changes -- so you can ignore those). This allows experiment tracking to use static data as a fallback when it can't connect to the backend GraphQL, enabling us to fully static host the demo site.
• Updated the GitHub workflow to:
  • Install Kedro and its dependencies.
  • Install Node.js.
  • Build the React app.
  • Pip install the latest development version of Kedro.
  • Build Kedro-viz using this latest dev version.
  • Host the demo site on GitHub Pages.

Next Steps:

Eventually, we will transition to using publish-share-kedro-viz action. For now, until we release the above changes, this method will allow our demo site to function. We plan to test publish-share-kedro-viz action on a test repo after the release to ensure it works as expected.

Once this PR is approved, I will merge it to main and push it to the demo branch, triggering the 'new' deploy-demo workflow. Afterward, I will update demo.kedro.org to point to the GitHub Pages site.

Test link - https://kedro-org.github.io/kedro-viz/?types=nodes,datasets&pid=__default__&expandAllPipelines=false

Checklist

• Read the contributing guidelines
• Opened this PR as a 'Draft Pull Request' if it is work-in-progress
• Updated the documentation to reflect the code changes
• Added new entries to the RELEASE.md file
• Added tests to cover my changes

[ravi-kumar-pilla]

build seems to be in the root similar to lib. Why is this needed ?

[rashidakanchwala]

we want to ignore the root build but keep the demo/build. build folder is created when you do npm run build and we don't want to accidentally push that to github.

[ravi-kumar-pilla]

yes, I understand that. Before this change we were doing the same right. The forward slash might not be needed I guess

[rashidakanchwala]

when i remove the forward slash, it also ignores the demo/build which we don't want to ignore anymore as it has static graphql files

[jitu5]

@rashidakanchwala In this PR we are adding all the required files in demo-project/build but what happens for new release? will it overwrite existing build folder ?

[rashidakanchwala]

@rashidakanchwala In this PR we are adding all the required files in demo-project/build but what happens for new release? will it overwrite existing build folder ?

@jitu5 ,

In the current build folder, I’ve included only the GraphQL files and the .api/packages-compatibilities file. I tested the setup, and during the kedro viz build, these files are not deleted. Additionally, other files, such as api/main, api/nodes, and api/pipelines, are added during the GitHub workflow but these are not persistant like the one's I have added.

[ravi-kumar-pilla]

Instead of checking for network error and then reading from a static file path, can we check for the host url ? Like if the url host is the demo site, then fetch from file instead of making a network call ? This seems like a round-trip which is not needed if we already know the request is made from demo site

[jitu5]

But we still cant ignore below errors, right ?

[rashidakanchwala]

I am thinking doing this but first I want to test it out with demo.kedro.org. So I will make this change in a follow up PR where I update the github workflow to 'public-kedro-viz' actions