ci: remove lerna, leverage basic shell script

ElysaSrc · ElysaSrc · commit 46b31f0f1775 · 2024-07-10T13:04:57.000+02:00
diff --git a/.github/scripts/publish.sh b/.github/scripts/publish.sh
@@ -0,0 +1,56 @@
+#!/bin/sh
+set -e
+
+# List of packages to publish
+# CHANGE IT WHEN ADDING A NEW PROJECT TO BE RELEASED.
+PACKAGES=(
+  "ui-icons" 
+  "ui-core"
+  "ui-speedspacechart"
+  "ui-spacetimechart"
+  "ui-manchette"
+)
+
+# Get the version from the tag
+VERSION=${GITHUB_REF/refs\/tags\//}
+
+# Helper function to update the version and publish the package
+# Note : we are in the CI triggered by a release, we do not need to create a tag nor commit
+version_and_publish() {
+  local dir=$1
+  local version=$2
+
+  # Go to the package directory
+  pushd $dir
+
+  # Set version in package.json
+  npm version $version --no-git-tag-version
+
+  # Update dependencies to match the new version
+  # This jq script will search for dependencies starting with "@osrd-project" and 
+  # update them to the new version
+  jq \
+    --arg v "$version" \
+    '
+      (.dependencies // {} | with_entries(if .key | startswith("@osrd-project") then .value = $v else . end)) as $d |
+      (.devDependencies // {} | with_entries(if .key | startswith("@osrd-project") then .value = $v else . end)) as $ddev |
+      .dependencies = $d | .devDependencies = $ddev
+    ' \
+    package.json > package.tmp.json
+
+  # Overwrite the package.json with the updated version
+  mv package.tmp.json package.json
+
+  # Publish the package
+  npm publish
+
+  # Back to root
+  popd
+}
+
+# Publish each package
+for dir in "${PACKAGES[@]}"; do
+  echo "::group::Publishing $dir"
+  version_and_publish $dir $VERSION
+  echo "::endgroup::"
+done
diff --git a/.github/workflows/osrd-ui-publish.yml b/.github/workflows/osrd-ui-publish.yml
@@ -32,6 +32,5 @@ jobs:
 
       - name: Publish
         run: |
-          VERSION=${GITHUB_REF/refs\/tags\//}
           npm ci
-          npm run lerna -- publish ${VERSION} --force-publish --yes --no-push --no-git-tag-version
+          ./.github/scripts/publish.sh
diff --git a/README.md b/README.md
@@ -2,13 +2,40 @@
 
 Icons, fonts, colors, components and all user interface items for OSRD project.
 
-## TODO
+## Development
 
-We should write a README to explain the goal of the `osrd-ui` repository and the design system as
-the whole.
+Development will leverage preconstruct. **Documentation yet to come**.
 
-We should also explain how it is related to the `osrd-design` repository.
+## Publishing versions
 
-## Credits
+In a nutshell: we consider our version numbers metadata of the project. We use [Semantic Versioning](https://semver.org/).
 
-### ui-icons
+### Implications
+
+We do not change the version on local package versions, we keep the file to the version `0.0.1-dev` which is not a real version and can be easily identified as a development version.
+
+The version numbers for our releases are solely managed through git tags. It implies that when we update a single package, we release all the project together : even if there are no changes between two release (let's say we update ui-icons but nothing else, we would make a release that would publish all packages anyway).
+
+It's the tradeoff we make to keep the project simple and easy to manage, and to avoid the complexity of managing multiple compatible versions of the project.
+
+In summary : we conside a version number as being an indivisible release of all the subpackages of the repository.
+
+### Making a release
+
+1. Create a git tag (let's say `0.0.30`) on the `dev` branch and push it. **Note: we do not tag with a V in front of the semver, IT'S 0.0.30 AND NOT v0.0.30**.
+2. Create a github release (By convention, we use the same name as the tag with a v in front of it, `v0.0.30`. You can give fancy names to release if you want to : `0.0.30 : Camembert`, it will only appear in the release page of GitHub).
+
+### Adding a new package to the monorepo
+
+1. Create a folder and follow the structure of the other packages (refer to the Development section for more information).
+2. In the file `./.github/scripts/publish.sh`, search for the PACKAGES array and add your package in it. See below:
+
+```bash
+  # List of packages to publish
+  # CHANGE IT WHEN ADDING A NEW PROJECT TO BE RELEASED.
+  PACKAGES=(
+    "ui-icons" 
+    "ui-core"
+    # <- Add your package here (it's a bash array)
+  )
+```
diff --git a/flake.lock b/flake.lock
diff --git a/flake.nix b/flake.nix
@@ -4,33 +4,36 @@
   inputs = {
     nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
     flake-utils.url = "github:numtide/flake-utils";
-    flake-compat.url = "https://flakehub.com/f/edolstra/flake-compat/1.tar.gz";
     alejandra = {
       url = "github:kamadorueda/alejandra/3.0.0";
       inputs.nixpkgs.follows = "nixpkgs";
     };
   };
 
-  outputs = { self, nixpkgs, flake-utils, ... }@inputs:
+  outputs = { self, nixpkgs, flake-utils, alejandra, ... }@inputs:
     flake-utils.lib.eachDefaultSystem (system:
       let
         pkgs = import nixpkgs {
           inherit system;
           overlays = [];
         };
-        fixedNode = pkgs.nodejs-18_x;
+        fixedNode = pkgs.nodejs_22;
         fixedNodePackages = pkgs.nodePackages.override {
           nodejs = fixedNode;
         };
       in
       {
         devShell = pkgs.mkShell {
           buildInputs = with pkgs; [ 
+            # Nix formatter
+            alejandra.defaultPackage.${system}
+
+            # Node version
             fixedNode 
             fixedNodePackages.npm
             fixedNodePackages.yarn
           ];
         };
       }
     );
-}
+}
diff --git a/lerna.json b/lerna.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@osrd-project/root",
-  "version": "0.1.0",
+  "version": "0.0.1-dev",
   "homepage": "https://github.com/osrd-project/osrd-ui#readme",
   "repository": {
     "type": "git",
@@ -25,11 +25,7 @@
     "clean": "npm run clean --workspaces --if-present",
     "build": "npm run build --workspaces --if-present",
     "test": "npm run test --workspaces --if-present",
-    "storybook": "npm start --workspace='@osrd-project/storybook'",
-    "lerna:changed": "lerna changed",
-    "lerna:diff": "lerna diff",
-    "lerna": "lerna",
-    "lerna:publish": "lerna publish from-package --no-private --yes"
+    "storybook": "npm start --workspace='@osrd-project/storybook'"
   },
   "type": "module",
   "devDependencies": {
@@ -48,12 +44,11 @@
     "eslint-plugin-react": "^7.33.2",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-storybook": "^0.6.15",
-    "lerna": "^8.1.2",
     "prettier": "^3.2.5",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "rimraf": "^5.0.5",
     "rollup": "^4.13.0",
     "typescript": "^5.4.2"
   }
-}
+}
diff --git a/shell.nix b/shell.nix
diff --git a/ui-core/package.json b/ui-core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@osrd-project/ui-core",
-  "version": "0.0.27",
+  "version": "0.0.1-dev",
   "license": "LGPL-3.0-or-later",
   "bugs": "https://github.com/osrd-project/osrd-ui/issues",
   "repository": {
@@ -52,4 +52,4 @@
     "rollup-plugin-serve": "^1.1.1"
   },
   "gitHead": "973ad1478be4544e1c97303b844903247d9a9cd7"
-}
+}
diff --git a/ui-icons/package.json b/ui-icons/package.json
@@ -1,13 +1,16 @@
 {
   "name": "@osrd-project/ui-icons",
-  "version": "0.0.27",
+  "version": "0.0.1-dev",
   "license": "LGPL-3.0-or-later",
   "bugs": "https://github.com/osrd-project/osrd-ui/issues",
   "repository": {
     "type": "git",
     "url": "https://github.com/osrd-project/osrd-ui.git",
     "directory": "ui-icons"
   },
+  "publishConfig": {
+    "access": "public"
+  },
   "type": "module",
   "module": "./dist/index.esm.js",
   "types": "./dist/index.d.ts",
@@ -37,4 +40,4 @@
     "svgo": "3.2.0"
   },
   "gitHead": "973ad1478be4544e1c97303b844903247d9a9cd7"
-}
+}
diff --git a/ui-manchette/package.json b/ui-manchette/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@osrd-project/ui-manchette",
-  "version": "0.0.27",
+  "version": "0.0.1-dev",
   "license": "LGPL-3.0-or-later",
   "bugs": "https://github.com/osrd-project/osrd-ui/issues",
   "repository": {
@@ -34,7 +34,7 @@
     "prepublishOnly": "npm run clean && npm run build"
   },
   "dependencies": {
-    "@osrd-project/ui-spacetimechart": "^0.0.27",
+    "@osrd-project/ui-spacetimechart": "0.0.1-dev",
     "classnames": "^2.5.1",
     "lodash.isequal": "^4.5.0",
     "tailwindcss": "^3.4.1"
@@ -53,4 +53,4 @@
     "rollup-plugin-serve": "^1.1.1"
   },
   "gitHead": "973ad1478be4544e1c97303b844903247d9a9cd7"
-}
+}
diff --git a/ui-spacetimechart/package.json b/ui-spacetimechart/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@osrd-project/ui-spacetimechart",
-  "version": "0.0.27",
+  "version": "0.0.1-dev",
   "license": "LGPL-3.0-or-later",
   "bugs": "https://github.com/osrd-project/osrd-ui/issues",
   "repository": {
@@ -43,4 +43,4 @@
     "lodash": "^4.17.21",
     "vitest": "^1.5.0"
   }
-}
+}
diff --git a/ui-speedspacechart/package.json b/ui-speedspacechart/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@osrd-project/ui-speedspacechart",
-  "version": "0.0.27",
+  "version": "0.0.1-dev",
   "license": "LGPL-3.0-or-later",
   "bugs": "https://github.com/osrd-project/osrd-ui/issues",
   "repository": {
@@ -54,4 +54,4 @@
     "rollup-plugin-serve": "^1.1.1"
   },
   "gitHead": "973ad1478be4544e1c97303b844903247d9a9cd7"
-}
+}
diff --git a/ui-warped-map/package.json b/ui-warped-map/package.json

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@osrd-project/ui-spacetimechart",`
`3`		`- "version": "0.0.27",`
	`3`	`+ "version": "0.0.1-dev",`
`4`	`4`	`"license": "LGPL-3.0-or-later",`
`5`	`5`	`"bugs": "https://github.com/osrd-project/osrd-ui/issues",`
`6`	`6`	`"repository": {`
`@@ -43,4 +43,4 @@`
`43`	`43`	`"lodash": "^4.17.21",`
`44`	`44`	`"vitest": "^1.5.0"`
`45`	`45`	`}`
`46`		`-}`
	`46`	`+}`