airline-codes 1.0.2 → 1.1.0

package/.github/workflows/publish.yml

@@ -0,0 +1,21 @@
+name: Publish to npm
+
+on:
+  push:
+    branches: [master]
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # required for npm trusted publishing (OIDC)
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm install -g npm@latest
+      - run: npm install
+      - run: unset NODE_AUTH_TOKEN && npm publish --provenance --access public

package/.github/workflows/update-data.yml

@@ -0,0 +1,37 @@
+name: Update Airline Data
+
+on:
+  schedule:
+    - cron: '0 6 * * 1'  # every Monday at 6am UTC
+  workflow_dispatch:
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - name: Fetch latest airlines.dat from OpenFlights
+        run: wget -q https://raw.githubusercontent.com/jpatokal/openflights/master/data/airlines.dat
+      - name: Apply local corrections to airlines.dat
+        run: node normalize.js
+      - name: Regenerate airlines.json
+        run: node convert.js
+      - name: Commit and push if data changed
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          if git diff --quiet airlines.dat airlines.json; then
+            echo "No data changes, skipping."
+          else
+            npm version patch --no-git-tag-version
+            git add airlines.dat airlines.json package.json package-lock.json
+            git commit -m "chore: update airline data from OpenFlights"
+            git push origin master
+          fi

package/README.md

@@ -27,19 +27,27 @@ require('airline-codes/airlines.json');
 
 ## Update the list of Airline Codes
 
-### Fetch Airline codes
+Data is synced automatically every week from [jpatokal/openflights](https://github.com/jpatokal/openflights). To update manually:
 
 ```
 $ wget https://raw.githubusercontent.com/jpatokal/openflights/master/data/airlines.dat
+$ node normalize.js   # apply local corrections (country names, etc.)
+$ node convert.js     # regenerate airlines.json from airlines.dat
 ```
 
-### Generate the list
+### Adding corrections
 
-Convert the list of airlines codes from csv format to JSON.
+Upstream data uses different conventions for some country names and contains occasional data quality issues. `normalize.js` maintains a `COUNTRY_CORRECTIONS` map that is applied automatically after every upstream fetch. To add a new correction, edit the map in `normalize.js`:
 
+```javascript
+var COUNTRY_CORRECTIONS = {
+  'Macao': 'Macau',
+  'Republic of Korea': 'South Korea',
+  // add new entries here ...
+};
 ```
-node convert.js
-```
+
+After editing, re-run the pipeline above to apply the change.
 
 ## Thanks