[CICD] Add releasing to npmjs (#2)

vojtechpavlu · Apr 8, 2024 · ed3c780 · ed3c780
1 parent b72d130
commit ed3c780
Show file tree

Hide file tree

Showing 15 changed files with 297 additions and 107 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,67 @@
+name: Release
+
+on:
+  # On push to master branch and only if the package.json has changed
+  push:
+    paths:
+      - package.json
+    branches:
+      - master
+
+env:
+  NODE_VERSION: 20
+  NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+
+jobs:
+  release:
+    name: Publish to NPM
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js ${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-npm-
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run Unit tests
+        run: npm run test:unit
+
+      - name: Link from root project
+        run: npm link
+
+      - name: Install dependencies in nested project
+        run: npm install
+        working-directory: ./integration
+
+      - name: Link to nested project
+        run: npm link @falbricate/geography
+        working-directory: ./integration
+
+      - name: Run Integration tests
+        run: npm run test:integration
+
+      - name: Compile
+        run: npm run compile
+
+      - name: Build
+        run: npm run build
+
+      - name: Publish to NPM
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ env.NPM_AUTH_TOKEN }}
diff --git a/.npmignore b/.npmignore
@@ -12,3 +12,4 @@ unit-test.config.js
 tsconfig.json
 tsup.config.ts
 docs
+integration
diff --git a/integration/integration-tests.config.js b/integration/integration-tests.config.js
@@ -4,5 +4,5 @@
 module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
-  resetModules: true
+  resetModules: true,
 };
diff --git a/integration/tests/Plugin.test.ts b/integration/tests/Plugin.test.ts
@@ -1,4 +1,8 @@
-import { getStandard, getValueGenerator, registerPlugin } from '@falbricate/base';
+import {
+  getStandard,
+  getValueGenerator,
+  registerPlugin,
+} from '@falbricate/base';
 import { GeographyPlugin } from '../../src';
 
 describe('Not failing Plugin registration', () => {
@@ -10,7 +14,7 @@ describe('Not failing Plugin registration', () => {
 describe('Registering contents', () => {
   it('should register Random Country Generator', () => {
     const config = {
-      countries: ['no', 'it']
+      countries: ['no', 'it'],
     };
 
     expect(() => getValueGenerator('random-country', config)).not.toThrow();
@@ -20,4 +24,3 @@ describe('Registering contents', () => {
     expect(() => getStandard('country-abbr-eu')).not.toThrow();
   });
 });
-
diff --git a/package.json b/package.json
@@ -1,7 +1,11 @@
 {
   "name": "@falbricate/geography",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Geographical data plugin for Falbricate",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vojtechpavlu/falbricate-geography.git"
+  },
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",

diff --git a/src/data/base.ts b/src/data/base.ts
@@ -9,7 +9,7 @@ export type NamedGeography = {
   type: GeographyType;
   name: string;
   abbr: string;
-}
+};
 
 /** Declaration of regions and groups */
 export interface Region extends NamedGeography {

diff --git a/src/data/countries/european.ts b/src/data/countries/european.ts
@@ -8,7 +8,12 @@ export const EUROPEAN_COUNTRIES: Country[] = [
   { type: 'country', abbr: 'az', name: 'Azerbaijan', capital: 'Baku' },
   { type: 'country', abbr: 'by', name: 'Belarus', capital: 'Minsk' },
   { type: 'country', abbr: 'be', name: 'Belgium', capital: 'Brussels' },
-  { type: 'country', abbr: 'ba', name: 'Bosnia and Herzegovina', capital: 'Sarajevo' },
+  {
+    type: 'country',
+    abbr: 'ba',
+    name: 'Bosnia and Herzegovina',
+    capital: 'Sarajevo',
+  },
   { type: 'country', abbr: 'bg', name: 'Bulgaria', capital: 'Sofia' },
   { type: 'country', abbr: 'hr', name: 'Croatia', capital: 'Zagreb' },
   { type: 'country', abbr: 'cy', name: 'Cyprus', capital: 'Nicosia' },
@@ -28,7 +33,7 @@ export const EUROPEAN_COUNTRIES: Country[] = [
   { type: 'country', abbr: 'li', name: 'Liechtenstein', capital: 'Vaduz' },
   { type: 'country', abbr: 'lt', name: 'Lithuania', capital: 'Vilnius' },
   { type: 'country', abbr: 'lu', name: 'Luxembourg', capital: 'Luxembourg' },
-  { type: 'country', abbr: 'mt', name: 'Malta', capital: 'St. Paul\'s Bay' },
+  { type: 'country', abbr: 'mt', name: 'Malta', capital: "St. Paul's Bay" },
   { type: 'country', abbr: 'md', name: 'Moldova', capital: 'Chisinau' },
   { type: 'country', abbr: 'mc', name: 'Monaco', capital: 'Monaco' },
   { type: 'country', abbr: 'me', name: 'Montenegro', capital: 'Podgorica' },
@@ -49,5 +54,5 @@ export const EUROPEAN_COUNTRIES: Country[] = [
   { type: 'country', abbr: 'tr', name: 'Turkey', capital: 'Ankara' },
   { type: 'country', abbr: 'ua', name: 'Ukraine', capital: 'Kyiv' },
   { type: 'country', abbr: 'uk', name: 'United Kingdom', capital: 'London' },
-  { type: 'country', abbr: 'va', name: 'Vatican', capital: 'Vatican City' }
+  { type: 'country', abbr: 'va', name: 'Vatican', capital: 'Vatican City' },
 ];
diff --git a/src/data/regions/european/index.ts b/src/data/regions/european/index.ts
@@ -6,95 +6,168 @@ export const EUROPEAN_REGIONS: Region[] = [
     abbr: 'eu',
     name: 'European Union',
     subs: [
-      'at', 'be', 'bg', 'hr', 'cy', 'cz', 'dk', 'fi', 'ee', 'fr', 'de',
-      'gr', 'hu', 'ie', 'it', 'lv', 'lt', 'lu', 'mt', 'nl', 'pl', 'pt',
-      'ro', 'sk', 'si', 'es', 'se'
-    ]
-  }, {
+      'at',
+      'be',
+      'bg',
+      'hr',
+      'cy',
+      'cz',
+      'dk',
+      'fi',
+      'ee',
+      'fr',
+      'de',
+      'gr',
+      'hu',
+      'ie',
+      'it',
+      'lv',
+      'lt',
+      'lu',
+      'mt',
+      'nl',
+      'pl',
+      'pt',
+      'ro',
+      'sk',
+      'si',
+      'es',
+      'se',
+    ],
+  },
+  {
     type: 'region',
     abbr: 'not-eu',
     name: 'European Countries not in EU',
     subs: [
-      'al', 'ad', 'am', 'az', 'by', 'ba', 'ge', 'is', 'li', 'md', 'mc',
-      'me', 'mkd', 'no', 'ru', 'sm', 'rs', 'ch', 'tr', 'ua', 'uk', 'va'
-    ]
-  }, {
+      'al',
+      'ad',
+      'am',
+      'az',
+      'by',
+      'ba',
+      'ge',
+      'is',
+      'li',
+      'md',
+      'mc',
+      'me',
+      'mkd',
+      'no',
+      'ru',
+      'sm',
+      'rs',
+      'ch',
+      'tr',
+      'ua',
+      'uk',
+      'va',
+    ],
+  },
+  {
     type: 'region',
     abbr: 'europe',
     name: 'Europe',
-    subs: ['eu', 'not-eu']
-  }, {
+    subs: ['eu', 'not-eu'],
+  },
+  {
     type: 'region',
     abbr: 'nordics',
     name: 'Nordic countries',
-    subs: ['dk', 'fi', 'no', 'se', 'is']
-  }, {
+    subs: ['dk', 'fi', 'no', 'se', 'is'],
+  },
+  {
     type: 'region',
     abbr: 'baltics',
     name: 'Baltic states',
-    subs: ['ee', 'lv', 'lt']
-  }, {
+    subs: ['ee', 'lv', 'lt'],
+  },
+  {
     type: 'region',
     abbr: 'v4',
     name: 'Visegrád Group',
-    subs: ['cz', 'hu', 'pl', 'sk']
-  }, {
+    subs: ['cz', 'hu', 'pl', 'sk'],
+  },
+  {
     type: 'region',
     abbr: 'benelux',
     name: 'Benelux',
-    subs: ['be', 'nl', 'lu']
-  }, {
+    subs: ['be', 'nl', 'lu'],
+  },
+  {
     type: 'region',
     abbr: 'iberia',
     name: 'Iberian Penisula',
-    subs: ['es', 'pt']
-  }, {
+    subs: ['es', 'pt'],
+  },
+  {
     type: 'region',
     abbr: 'balkans',
     name: 'Balkan Countries',
-    subs: ['al', 'ba', 'bg', 'hr', 'me', 'mkd', 'rs']
-  }, {
+    subs: ['al', 'ba', 'bg', 'hr', 'me', 'mkd', 'rs'],
+  },
+  {
     type: 'region',
     abbr: 'balkans-broad',
     name: 'Broad Balkan Countries',
-    subs: ['balkans', 'gr', 'ro', 'si', 'tr']
-  }, {
+    subs: ['balkans', 'gr', 'ro', 'si', 'tr'],
+  },
+  {
     type: 'region',
     abbr: 'n-europe',
     name: 'Northern Europe',
-    subs: ['dk', 'ee', 'fi', 'is', 'ie', 'lv', 'lt', 'no', 'se', 'uk']
-  }, {
+    subs: ['dk', 'ee', 'fi', 'is', 'ie', 'lv', 'lt', 'no', 'se', 'uk'],
+  },
+  {
     type: 'region',
     abbr: 's-europe',
     name: 'Southwest Europe',
     subs: [
-      'al', 'ad', 'ba', 'hr', 'gr', 'va', 'it', 'mt', 'me', 'pt', 'sm',
-      'rs', 'si', 'es', 'mkd'
-    ]
-  }, {
+      'al',
+      'ad',
+      'ba',
+      'hr',
+      'gr',
+      'va',
+      'it',
+      'mt',
+      'me',
+      'pt',
+      'sm',
+      'rs',
+      'si',
+      'es',
+      'mkd',
+    ],
+  },
+  {
     type: 'region',
     abbr: 'w-europe',
     name: 'Western Europe',
-    subs: ['au', 'be', 'fr', 'de', 'li', 'lu', 'mc', 'nl', 'ch']
-  }, {
+    subs: ['au', 'be', 'fr', 'de', 'li', 'lu', 'mc', 'nl', 'ch'],
+  },
+  {
     type: 'region',
     abbr: 'e-europe',
     name: 'Eastern Europe',
-    subs: ['bg', 'by', 'cz', 'hu', 'md', 'pl', 'ro', 'ru', 'sk', 'ua']
-  }, {
+    subs: ['bg', 'by', 'cz', 'hu', 'md', 'pl', 'ro', 'ru', 'sk', 'ua'],
+  },
+  {
     type: 'region',
     abbr: 'c-europe',
     name: 'Central Europe',
-    subs: ['at', 'de', 'cz', 'sk', 'pl', 'hu']
-  }, {
+    subs: ['at', 'de', 'cz', 'sk', 'pl', 'hu'],
+  },
+  {
     type: 'region',
     abbr: 'sw-europe',
     name: 'Southwest Europe',
-    subs: ['es', 'pt']
-  }, {
+    subs: ['es', 'pt'],
+  },
+  {
     type: 'region',
     abbr: 'se-europe',
     name: 'Southeast Europe',
-    subs: ['balkans-broad', 'it']
-  }
-];
+    subs: ['balkans-broad', 'it'],
+  },
+];