Refactor CI for forked repositories - POC

.github/actions/reports-group/.editorconfig

@@ -0,0 +1,3 @@
+[{*.yml, *.json}]
+indent_style = space
+indent_size = 2

.github/actions/reports-group/Makefile

@@ -0,0 +1,13 @@
+PKG_LIST := node-sdk find load-metadata create codecov-uploader codacy-uploader
+TARGETS := configure install build package lint test
+
+define FOR_EACH_PKG
+    @for PKG in $(PKG_LIST); do \
+	    echo ">>>>>> $(1) \"$$PKG\" Package >>>>>>"; \
+	    $(MAKE) -C $$PKG $(1) || exit 1; \
+	    echo "<<<<<<\n"; \
+    done
+endef
+
+$(TARGETS):
+	$(call FOR_EACH_PKG,$@)

.github/actions/reports-group/codacy-uploader/Makefile

@@ -0,0 +1,19 @@
+.PHONY: install
+install:
+	@echo "Nothing to install !"
+
+.PHONY: build
+build:
+	@echo "Nothing to build !"
+
+.PHONY: package
+package:
+	@echo "Nothing to pack !"
+
+.PHONY: lint
+lint:
+	@echo "Nothing to lint !"
+
+.PHONY: test
+test:
+	@echo "Nothing to test !"

.github/actions/reports-group/codacy-uploader/action.yml

@@ -0,0 +1,96 @@
+name: TODO
+description: TODO
+
+inputs:
+  path:
+    description: A group directory or a glob pattern in order to find group directories and merge their metadata
+    required: true
+  project-token:
+    description: Codacy project token for the repository
+    required: true
+  follow-symbolic-links:
+    description: |
+      Indicates whether to follow symbolic links when resolving `path`
+    default: 'true'
+
+outputs:
+  groups:
+    description: TODO
+    value: ${{ steps.build-outputs.outputs.groups }}
+  reports:
+    description: TODO
+    value: ${{ steps.build-outputs.outputs.reports }}
+
+runs:
+  using: "composite"
+  steps:
+    # Even if an input is marked as "required", an empty value (or no value) may be passed !
+    - name: Validate inputs
+      uses: actions/github-script@v7
+      env:
+        INPUT_MAP: ${{ toJson(inputs) }}
+      with:
+        script: |
+          return core.group(
+            'Validate inputs',
+            async () => Object.entries(JSON.parse(process.env.INPUT_MAP))
+              .forEach(([key, val]) => {
+                if (!val.trim()) { throw new Error(`Input required and not supplied: ${name}`); }
+              })
+          );
+
+    # @TODO move reports-group/load-metadata action to a dedicated repo and remove the checkout
+    - uses: actions/checkout@v4
+      with:
+        path: custom-action-repo
+
+    - name: Load groups metadata
+      id: load-metadata
+      uses: ./custom-action-repo/.github/actions/reports-group/load-metadata
+      with:
+        path: ${{ inputs.path }}
+        format: string # String in order to concatenate interesting values
+        glue-string: ',' # Ensure glue string as it's the expected one by the uploader
+        follow-symbolic-links: ${{ inputs.follow-symbolic-links }}
+
+    - name: Build uploader option
+      id: build-uploader-options
+      uses: actions/github-script@v7
+      env:
+        METADATA: ${{ steps.load-metadata.outputs.metadata }}
+      with:
+        script: |
+          core.info('Build uploader options');
+          const {METADATA} = process.env;
+
+          const metadata = JSON.parse(METADATA);
+          core.setOutput('coverage-reports', metadata.reportPaths); // Trusted path as it comes from trusted metadata (=from `reports-group/load-metadata`)
+
+    - name: Ensure at least one report to upload
+      if: ${{ '' == steps.build-uploader-options.outputs.coverage-reports }}
+      uses: actions/github-script@v7
+      with:
+        script: |
+          core.setFailed('Unable to retrieve any report to upload. Something wrong most likely happened !');
+
+    - name: Upload to codacy
+      id: upload
+      uses: codacy/codacy-coverage-reporter-action@v1
+      with:
+        coverage-reports: ${{ steps.build-uploader-options.outputs.coverage-reports }}
+        project-token: ${{ inputs.project-token }}
+
+    - name: Build action outputs
+      id: build-outputs
+      uses: actions/github-script@v7
+      env:
+        METADATA: ${{ steps.load-metadata.outputs.metadata }}
+        REPORTS: ${{ steps.build-uploader-options.outputs.coverage-reports }}
+      with:
+        script: |
+          core.info('Build output');
+          const {REPORTS, METADATA} = process.env;
+
+          const metadata = JSON.parse(METADATA);
+          core.setOutput('groups', metadata.path.split(',').join('\n')); // Trusted path as it comes from trusted metadata (=from `reports-group/load-metadata`)
+          core.setOutput('reports', REPORTS.split(',').join('\n')); // Trusted path, see `build-uploader-options` step

.github/actions/reports-group/codecov-uploader/Makefile

@@ -0,0 +1,19 @@
+.PHONY: install
+install:
+	@echo "Nothing to install !"
+
+.PHONY: build
+build:
+	@echo "Nothing to build !"
+
+.PHONY: package
+package:
+	@echo "Nothing to pack !"
+
+.PHONY: lint
+lint:
+	@echo "Nothing to lint !"
+
+.PHONY: test
+test:
+	@echo "Nothing to test !"

.github/actions/reports-group/codecov-uploader/action.yml

@@ -0,0 +1,117 @@
+name: TODO
+description: TODO
+
+inputs:
+  path:
+    description: A group directory or a glob pattern in order to find group directories and merge their metadata
+    required: true
+  token:
+    description: Codecov upload token
+    required: true
+  follow-symbolic-links:
+    description: |
+      Indicates whether to follow symbolic links when resolving `path`
+    default: 'true'
+
+outputs:
+  groups:
+    description: TODO
+    value: ${{ steps.build-outputs.outputs.groups }}
+  name:
+    description: TODO
+    value: ${{ steps.build-outputs.outputs.name }}
+  reports:
+    description: TODO
+    value: ${{ steps.build-outputs.outputs.reports }}
+  flags:
+    description: TODO
+    value: ${{ steps.build-outputs.outputs.flags }}
+
+runs:
+  using: "composite"
+  steps:
+    # Even if an input is marked as "required", an empty value (or no value) may be passed !
+    - name: Validate inputs
+      uses: actions/github-script@v7
+      env:
+        INPUT_MAP: ${{ toJson(inputs) }}
+      with:
+        script: |
+          return core.group(
+            'Validate inputs', 
+            async () => Object.entries(JSON.parse(process.env.INPUT_MAP))
+              .forEach(([key, val]) => {
+                if (!val.trim()) { throw new Error(`Input required and not supplied: ${name}`); }
+              })
+          );
+
+    # @TODO move reports-group/load-metadata action to a dedicated repo and remove the checkout
+    - uses: actions/checkout@v4
+      with:
+        path: custom-action-repo
+
+    - name: Load groups metadata
+      id: load-metadata
+      uses: ./custom-action-repo/.github/actions/reports-group/load-metadata
+      with:
+        path: ${{ inputs.path }}
+        format: string # String in order to concatenate interesting values
+        glue-string: ',' # Ensure glue string as it's the expected one by the uploader
+        follow-symbolic-links: ${{ inputs.follow-symbolic-links }}
+
+    - name: Build uploader option
+      id: build-uploader-options
+      uses: actions/github-script@v7
+      env:
+        METADATA: ${{ steps.load-metadata.outputs.metadata }}
+      with:
+        script: |
+          core.info('Build uploader options');
+          const {METADATA} = process.env;
+
+          const metadata = JSON.parse(METADATA);
+          core.setOutput('name', metadata.name);
+          core.setOutput('files', metadata.reportPaths); // Trusted path as it comes from trusted metadata (=from `reports-group/load-metadata`)
+          if (metadata.flags.length > 0) {
+            core.setOutput('flags', metadata.flags);
+          }
+
+    - name: Ensure at least one report to upload
+      if: ${{ '' == steps.build-uploader-options.outputs.files }}
+      uses: actions/github-script@v7
+      with:
+        script: |
+          core.setFailed('Unable to retrieve any report to upload. Something wrong most likely happened !');
+
+    - name: Upload to codacy
+      id: upload
+      uses: codecov/codecov-action@v4
+      with:
+        token: ${{ inputs.token }}
+        name: ${{ steps.build-uploader-options.outputs.name }}
+        files: ${{ steps.build-uploader-options.outputs.files }}
+        flags: ${{ steps.build-uploader-options.outputs.flags }}
+        # underlying CLI behavior
+        disable_search: true
+        # GHAction behavior
+        fail_ci_if_error: true
+        verbose: ${{ runner.debug == '1' }}
+
+    - name: Build action outputs
+      id: build-outputs
+      uses: actions/github-script@v7
+      env:
+        METADATA: ${{ steps.load-metadata.outputs.metadata }}
+        REPORT_NAME: ${{ steps.build-uploader-options.outputs.name }}
+        REPORT_FILES: ${{ steps.build-uploader-options.outputs.files }}
+        REPORT_FLAGS: ${{ steps.build-uploader-options.outputs.flags }}
+      with:
+        script: |
+          core.info('Build output');
+          const {REPORT_NAME, REPORT_FILES, REPORT_FLAGS, METADATA} = process.env;
+
+          const metadata = JSON.parse(METADATA);
+          core.setOutput('group', metadata.path.split(',').join('\n')); // Trusted path as it comes from trusted metadata (=from `reports-group/load-metadata`)
+          core.setOutput('name', REPORT_NAME);
+          core.setOutput('reports', REPORT_FILES.split(',').join('\n')); // Trusted path, see `build-uploader-options` step
+          core.setOutput('flags', undefined !== REPORT_FLAGS ? REPORT_FLAGS.split(',').join('\n') : '');

.github/actions/reports-group/create/.gitattributes

@@ -0,0 +1 @@
+dist/** -diff linguist-generated=true

.github/actions/reports-group/create/.gitignore

@@ -0,0 +1,2 @@
+.yarn
+node_modules

.github/actions/reports-group/create/.nvmrc

@@ -0,0 +1 @@
+20

.github/actions/reports-group/create/Makefile

@@ -0,0 +1,22 @@
+.PHONY: install
+install:
+	yarn install
+
+.PHONY: build
+build: install package
+
+.PHONY: package
+package:
+	rm -Rf dist/* && ./node_modules/.bin/ncc build index.js --minify --source-map --license LICENSE --out dist
+
+.PHONY: lint
+lint:
+	./node_modules/.bin/eslint  index.js
+
+.PHONY: test
+test:
+	echo "Error: no test specified"
+	exit 1
+
+get-action-nodejs-version: ## Display node version configured on action.yml
+	@grep -E "using:\s*'?node" action.yml | sed -e "s/^.*using: '*node\([0-9][0-9]\)'*.*$$/\1/"

.github/actions/reports-group/create/action.yml

@@ -0,0 +1,37 @@
+name: create
+description: |
+  Create a reports group directory under provided `path`, with a metada file and a copy of all `files`
+  Reports are expected to share the same format !
+inputs:
+  name:
+    description: Group name
+    required: true
+  format:
+    description: "`clover`, `cobertura`, `lcov`, etc"
+    required: true
+  files:
+    description: Multiline list of reports attached to the group
+    required: true
+  flags:
+    description: Multiline list of flags attached to the group
+    default: ''
+  path:
+    description: Root directory for the group directory (default to current directory)
+    default: '.'
+  follow-symbolic-links:
+    description: |
+      Indicates whether to follow symbolic links when resolving `files`
+    default: 'true'
+
+outputs:
+  path:
+    description: Path to the group directory
+  reports:
+    description: Multiline List of created reports for the group
+  files:
+    description: Multiline list of reports attached to the group. 
+      May be different than provided `files` in case of glob pattern !
+
+runs:
+  using: 'node20'
+  main: 'dist/index.js'