Merge pull request #4 from ikhokha/feature/cicd

update - cicd configs

Author: chaddyc

.eslintrc.json

@@ -0,0 +1,8 @@
+{
+	"parser": "@typescript-eslint/parser",
+	"extends": ["plugin:@typescript-eslint/recommended", "prettier/@typescript-eslint", "plugin:prettier/recommended"],
+	"parserOptions": {
+		"ecmaVersion": 2018,
+		"sourceType": "module"
+	}
+}

.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+
+updates:
+  - package-ecosystem: "github-actions" 
+    directory: "/" 
+    target-branch: "main"
+    schedule:
+      interval: "monthly"
+
+  - package-ecosystem: "npm" 
+    directory: "/" 
+    target-branch: "main"
+    schedule:
+      interval: "monthly"

.github/pull_request_template.md

@@ -0,0 +1,9 @@
+# Pull Request Details
+
+## Select type of change
+
+- [ ] New Feature
+- [ ] Documentation
+- [ ] Refactoring
+- [ ] HotFix
+- [ ] CICD

.github/workflows/build.yml

@@ -0,0 +1,37 @@
+name: Test Package Build
+
+on:
+    pull_request:
+        branches: [main]
+
+env:
+    GITHUB_PACKAGE_TOKEN: ${{ secrets.GHP_ACCESS_TOKEN}}
+    NPM_ACCESS_TOKEN: ${{ secrets.GHP_ACCESS_TOKEN }}
+
+jobs:
+    build-pkg:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v3
+
+            - name: Setup node
+              uses: actions/setup-node@v3
+              with:
+                  node-version: '18.x'
+
+            - name: Copying config files
+              run: cp ./.npmrc ~/.npmrc
+              shell: bash
+
+            - name: Install dependencies
+              run: yarn install
+
+            # - name: Linting
+            #   run: yarn lint --format junit -o reports/junit/js-lint-results.xml
+
+            - name: Typechecking
+              run: yarn typecheck
+
+            - name: Dry-run publish package
+              run: npm publish --dry-run

.github/workflows/publish.yml

@@ -0,0 +1,40 @@
+name: Publish Package
+
+on:
+    push:
+        branches: [main]
+
+env:
+    GITHUB_PACKAGE_TOKEN: ${{ secrets.GHP_ACCESS_TOKEN}}
+    NPM_ACCESS_TOKEN: ${{ secrets.GHP_ACCESS_TOKEN }}
+
+jobs:
+    publish-pkg:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v3
+
+            - name: Setup node
+              uses: actions/setup-node@v3
+              with:
+                  node-version: '18.x'
+
+            - name: Copying config files
+              run: cp ./.npmrc ~/.npmrc
+              shell: bash
+
+            - name: Install dependencies
+              run: yarn install
+
+            - name: Build
+              run: yarn build
+
+            # - name: Linting
+            #   run: yarn lint --format junit -o reports/junit/js-lint-results.xml
+        
+            - name: Typechecking
+              run: yarn typecheck
+
+            - name: Publish npm pkg
+              run: npm publish

.npmrc

@@ -1,3 +1,3 @@
 @ikhokha:registry=https://npm.pkg.github.com
 //npm.pkg.github.com/:_authToken=${GITHUB_PACKAGE_TOKEN}
-//registry.npmjs.org/:_authToken=${NPM_ACCESS_TOKEN}
+# //registry.npmjs.org/:_authToken=${NPM_ACCESS_TOKEN}

.prettierrc.json

@@ -0,0 +1,8 @@
+{
+	"printWidth": 130,
+	"useTabs": true,
+	"trailingComma": "all",
+	"singleQuote": false,
+	"semi": false,
+	"endOfLine": "lf"
+}

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ikhokha/octet-buffer",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "description": "Lightweight wrapper around Node Buffer, providing streaming read/write for uint8 to unit32",
     "author": "Simon Eumes <[email protected]>",
     "contributors": [
@@ -23,6 +23,7 @@
     "scripts": {
         "build": "rm -rf ./dist && tsc -p tsconfig.json",
         "typecheck": "tsc --noEmit",
+        "lint": "eslint src/**/*.ts --ext .ts",
         "test": "mocha src/**/*-Specs.ts"
     },
     "keywords": [
@@ -39,6 +40,12 @@
     "devDependencies": {
         "@types/chai": "^5.0.1",
         "@types/mocha": "^10.0.10",
+        "eslint": "^6.4.0",
+        "@typescript-eslint/eslint-plugin": "^2.3.2",
+		"@typescript-eslint/parser": "^2.3.1",
+		"eslint-config-prettier": "^6.3.0",
+		"eslint-plugin-prettier": "^3.1.1",
+        "prettier": "^1.18.2",
         "chai": "^5.1.2",
         "mocha": "^11.1.0",
         "tsx": "^4.19.2",