Automate changing link to documentation using git tag from RGBDS

[SelvinPL]

Closes #66

For testing remeber to clear the changes(undo the patches) to binjgb and rgbds.
You may use this commands from rgbds-live root directory:

cd rgbds && git clean -fd && git reset --hard && cd ../binjgb && git clean -fd && git reset --hard && cd ..

Then you are ready to execute ./build.sh
In other case build may fail as build is trying to apply patches every time

[avivace]

Cool, thanks @SelvinPL !

[avivace]

why are we setting this here in "build.sh"? This basically makes it mandatory to rebuild everything just to export this value, which could be done afterwards (or just anytime before npm run build/ serve... Isn't there a way to make this part of the npm run command?

[SelvinPL]

I didn't find a way to do this via command line ... I'm not good with node and npm run set environment variables search results aren't helpful

also doesn't
export VITE_RGBDS_VERSION=$(git --git-dir=rgbds/.git -c safe.directory='*' describe --tags --always) would export to the current console env variable VITE_RGBDS_VERSION
if so then every consecutive npm run build will use this value

[SelvinPL]

maybe, maybe build.sh may create .env file with this variable ... This should work, but I need to check this (and because RL stuff it need to wait 'till weekend)

[avivace]

So, I've quickly checked, and it should be enough to add
VITE_RGBDS_VERSION=$(git --git-dir=rgbds/.git -c safe.directory='*' describe --tags --always)

in the npm script. So, in package.json, something like:

"scripts": {
"dev": "VITE_RGBDS_VERSION=$(git --git-dir=rgbds/.git -c safe.directory='*' describe --tags --always) && vite",

should work

[SelvinPL]

So, I've quickly checked, and it should be enough to add VITE_RGBDS_VERSION=$(git --git-dir=rgbds/.git -c safe.directory='*' describe --tags --always)

in the npm script. So, in package.json, something like:

"scripts": { "dev": "VITE_RGBDS_VERSION=$(git --git-dir=rgbds/.git -c safe.directory='*' describe --tags --always) && vite",

should work

or maybe changing vite.config.js (as you need to change build not only dev and this should works for both)

import { defineConfig, loadEnv } from 'vite';
import { viteStaticCopy } from 'vite-plugin-static-copy';
import { execSync } from 'node:child_process';

export default defineConfig(({ command, mode, isSsrBuild, isPreview }) => {
	//tested on both win and linux execute git command and store result in process.env.VITE_RGBDS_VERSION
	process.env.VITE_RGBDS_VERSION = execSync("git --git-dir=rgbds/.git -c safe.directory='*' describe --tags --always").toString("utf8");
	return {
  base: '/rgbds-live/',
  build: {
    target: ['chrome109', 'safari15.6', 'firefox102'],
    outDir: 'www',
    chunkSizeWarningLimit: 1000,
  },
  resolve: {
    alias: {
      ace: 'ace-builds/src-noconflict/',
    },
  },
  plugins: [
    viteStaticCopy({
      targets: [
        {
          src: './node_modules/ace-builds/src-noconflict/**',
          dest: 'assets/ace',
        },
      ],
    }),
  ],
}});

[SelvinPL]

build vs dev see Deploy to GitHub Pages is using build
dev starts a local test server

[avivace]

Cool, I like this last option @SelvinPL