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

Repo/CI setup for IPCC article #47

Closed
18 tasks done
RaoOfPhysics opened this issue Jul 19, 2024 · 2 comments
Closed
18 tasks done

Repo/CI setup for IPCC article #47

RaoOfPhysics opened this issue Jul 19, 2024 · 2 comments

Comments

@RaoOfPhysics
Copy link
Member

RaoOfPhysics commented Jul 19, 2024

Working repo: https://github.com/explorable-viz/fluid-example-ipcc-ar6-01

  • Release 0.0.1 (empty PureScript build): explorable-viz/fluid-example-ipcc-ar6-01/releases/tag/0.0.1
    • Blank repo set up as Node application (see basic Node.js setup guidelines here)
    • Install purescript, spago, esbuild, purs-backend-es as dev dependencies (same versions as Fluid)
    • src/Article.purs with empty main
    • build target in package.json that compiles Article.purs to dist/article.js
    • GitHub Action that runs yarn build
    • index.html (based on template.html in fluid/web) that loads article.js
    • Remove package-lock.json (yarn.lock should be enough)
  • Release 0.0.2 (build empty Fluid visualisation): explorable-viz/fluid-example-ipcc-ar6-01/releases/tag/0.0.2
    • Add Fluid as repo submodule: explorable-viz/fluid-example-ipcc-ar6-01@75536ca
    • Fluid source code for:
      • Simple “dataset” with a few lines of made-up data (used actual data from the IPCC report)
      • Trivial Fluid chart based on that data
    • Metadata and drawfig code in Article.purs (adapt similar code in src/Publish/Renewables.purs from Fluid)
    • Update GitHub Action to initialise submodule (or configure checkout action to pull submodule automatically)
    • Use fluid-package (or similar) as name of submodule, to reserve fluid for source code/data sets – chosen name: fluid-submodule
    • serve target in package.json that serves article (adapt similar script in Fluid)
  • Release 0.0.3 (deploy GitHub Pages): explorable-viz/fluid-example-ipcc-ar6-01/releases/tag/0.0.3

Once explorable-viz/fluid#583 is finished, we can modify the GitHub Action to include yarn serve and some basic verification (using headless Chrome) that the web page loads correctly (e.g. without throwing a JavaScript error).

See:

@RaoOfPhysics
Copy link
Member Author

The repo is here: https://github.com/explorable-viz/fluid-example-ipcc-ar6-01/

And I hit a roadblock: explorable-viz/fluid-example-ipcc-ar6-01#1

See also explanation for why build script has been modified: explorable-viz/fluid-example-ipcc-ar6-01@e487ad8#r144510413

@RaoOfPhysics
Copy link
Member Author

yarn build finally works in GitHub Actions! :D

This was referenced Aug 19, 2024
@rolyp rolyp changed the title Standalone example article using IPCC report Repo/CI setup for IPCC article Aug 30, 2024
@rolyp rolyp mentioned this issue Sep 2, 2024
@rolyp rolyp added this to Fluid Sep 11, 2024
@github-project-automation github-project-automation bot moved this to Proposed in Fluid Sep 11, 2024
@rolyp rolyp moved this from Proposed to Recently completed in Fluid Sep 11, 2024
@rolyp rolyp moved this from Recently completed to Done in Fluid Sep 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

2 participants