Merge pull request #83 from boesing/refactor/typescript

Refactoring: typescript

Author: boesing

.eslintrc.json

@@ -0,0 +1,41 @@
+{
+    "parser": "@typescript-eslint/parser",
+    "env": {
+        "browser": false,
+        "es2021": true,
+        "node": true
+    },
+    "extends": [
+        "incredible",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "parserOptions": {
+        "ecmaVersion": 2021,
+        "ecmaFeatures": {
+            "modules": true
+        }
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+        "no-unused-vars": "off",
+        "@typescript-eslint/no-unused-vars": "error",
+        "node/no-unpublished-import": ["error", {
+            "allowModules": ["@cfworker/json-schema"]
+        }],
+        "no-process-exit": "off",
+        "no-sync": "off",
+        "no-shadow": "off",
+        "object-curly-spacing": "off",
+        "comma-dangle": "off",
+        "censor/no-swear": "off",
+        "@typescript-eslint/no-inferrable-types": "off",
+        "object-shorthand": "off"
+    },
+    "settings": {
+        "import/resolver": {
+            "typescript": {}
+        }
+    }
+}

.github/workflows/continuous-integration.yml

@@ -4,7 +4,9 @@ on:
   pull_request:
   push:
     branches:
+      - '[0-9]+.[0-9]+.x'
       - 'refs/pull/*'
+    tags:
 
 env:
   TEST_TAG: laminas/ci-matrix-action:test
@@ -82,7 +84,7 @@ jobs:
         id: matrix_generation
         env:
           PROJECT_NAME_TO_TEST: ${{ matrix.projectName }}
-        run: cd tests/${PROJECT_NAME_TO_TEST} && docker run -i --entrypoint /action/index.js -v $(realpath .):/github/workspace -w=/github/workspace ${TEST_TAG} $(test -r diff && cat diff || echo -n "")
+        run: cd tests/${PROJECT_NAME_TO_TEST} && docker run -i --entrypoint "/action/main.js" -v $(realpath .):/github/workspace -w=/github/workspace ${TEST_TAG} $(test -r diff && cat diff || echo -n "")
 
       - name: "Output generated matrix"
         uses: sergeysova/jq-action@v2
@@ -97,5 +99,34 @@ jobs:
         with:
           cmd: 'jq -c . < tests/${PROJECT_NAME_TO_TEST}/matrix.json'
 
-      - name: "verify output of generated matrix for project: empty-project"
-        run: diff --color <(echo '${{ steps.expected_matrix.outputs.value }}') <(echo '${{ steps.matrix_generation.outputs.matrix }}')
+      - name: "verify output of generated matrix for project: ${{ matrix.projectName }}"
+        run: diff --color <(echo '${{ steps.expected_matrix.outputs.value }}' | jq --sort-keys) <(echo '${{ steps.matrix_generation.outputs.matrix }}' | jq --sort-keys)
+
+  docker-build:
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Build
+        uses: docker/build-push-action@v2
+        with:
+          push: false
+
+  linting:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v2"
+      - uses: "actions/setup-node@v2"
+        with:
+          check-latest: true
+      - name: "Install node modules"
+        run: "npm ci"
+      - name: Run ESLint
+        run: "npm run lint"

.gitignore

@@ -1 +1,2 @@
 /node_modules/
+/dist/

Dockerfile

@@ -1,5 +1,16 @@
-FROM node:current-alpine
+FROM node:17-alpine as compiler
 
+RUN mkdir -p /usr/local/source
+WORKDIR /usr/local/source
+COPY package*.json ./
+COPY tsconfig.json ./
+COPY webpack.config.js ./
+RUN npm ci
+COPY ./src ./src
+RUN npm run build
+
+
+FROM node:17-alpine
 LABEL "repository"="http://github.com/laminas/laminas-ci-matrix-action"
 LABEL "homepage"="http://github.com/laminas/laminas-ci-matrix-action"
 LABEL "maintainer"="https://github.com/laminas/technical-steering-committee/"
@@ -8,14 +19,11 @@ RUN apk update \
     && apk add --no-cache bash git
 
 RUN mkdir /action
-ADD index.js /action/index.js
-RUN chmod u+x /action/index.js
-ADD src /action/src
-ADD package.json /action/package.json
-ADD package-lock.json /action/package-lock.json
-ADD composer.schema.json /action/
+ADD https://getcomposer.org/schema.json /action/composer.schema.json
 ADD laminas-ci.schema.json /action/
-RUN (cd /action ; npm install)
+
+COPY --from=compiler /usr/local/source/dist/main.js /action/
+RUN chmod u+x /action/main.js
 
 ADD entrypoint.sh /usr/local/bin/entrypoint.sh
 

README.md

@@ -221,3 +221,14 @@ $ docker run -v $(realpath .):/github/workspace -w=/github/workspace ghcr.io/lam
 ```
 
 This will run the action locally and detail what matrix will be produced; it can be particularly useful for debugging issues with your `.laminas-ci.json` configuration.
+
+## Development
+
+In case you want to contribute features, bugfixes, tests or JSONSchema enhancements, you might want to build the docker container locally.
+
+To do so, you can follow these steps:
+
+1. Build the docker container by executing `$ docker build -t laminas/laminas-ci-matrix-action:dev-local .`
+2. Change to the `tests/` directory you want to create a matrix for
+3. Run the docker container while overriding the `entrypoint.sh` to ensure the `diff` is being passed to the matrix generator
+   - `docker run -it --entrypoint "/action/main.js" -v $(realpath .):/github/workspace -w=/github/workspace docker.io/laminas/laminas-ci-matrix-action:dev-local $(test -r diff && cat diff || echo "")`