Skip to content

Commit

Permalink
#build-patch: build
Browse files Browse the repository at this point in the history
  • Loading branch information
reskume committed Dec 5, 2024
1 parent 83b5148 commit d390688
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 20 deletions.
14 changes: 7 additions & 7 deletions .github/workflows/github-create-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ jobs:
run-tests:
# only run if specific '#build' tag is found in commit message
if: contains(github.event.head_commit.message, '#build')
name: "Run tests"
name: 'Run tests'
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
Expand All @@ -19,14 +19,14 @@ jobs:
with:
node-version: 22
registry-url: https://npm.pkg.github.com/
scope: "@openaip"
scope: '@openaip'
- run: npm install
name: Install packages
env:
NODE_AUTH_TOKEN: ${{secrets.AUTOMATOR_DEVOPS_PAT}}
- run: npm run test
publish:
name: "Build and publish package"
name: 'Build and publish package'
needs: run-tests
runs-on: ubuntu-22.04
steps:
Expand All @@ -50,12 +50,12 @@ jobs:
env:
GITHUB_TOKEN: ${{ secrets.AUTOMATOR_DEVOPS_PAT }}
with:
major-wording: "#build-major"
minor-wording: "#build-minor"
patch-wording: "#build-patch"
major-wording: '#build-major'
minor-wording: '#build-minor'
patch-wording: '#build-patch'
# use "patch" as default bump strategy
default: patch
tag-prefix: "v"
tag-prefix: 'v'
- uses: actions/create-release@v1
name: Create release
env:
Expand Down
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,39 +136,44 @@ DP 54:20:00 N 010:40:00 E
DP 54:25:00 N 010:40:00 E
```

Extended OpenAIR Format
=
# Extended OpenAIR Format

The **original** OpenAIR format specification has multiple shortcomings to meet today's demand to reflect the various types of existing airspaces
and provide additional metadata. To overcome these shortcomings, an **extended** OpenAIR format is introduced that has several new tags.

### Extended Format Tags:

#### AI

A required unique identifier string for each airspace, e.g. a [UUID v4](https://en.wikipedia.org/wiki/Universally_unique_identifier). The _AI_ value must stay the same for each airspace throughout different versions if the file. The _AI_ tag must be placed either before or directly after the _AN_ tag. Placing the _AI_ tag before the _AN_ tag is preferred

#### AY

The optional _AY_ tag specifies the airspace type, e.g. "TMA", "CTR" or "TMZ". Unlike in the original format, the _AC_ tag must now only be used to specify the airspace _ICAO class_. If airspace has no type, i.e. is only ICAO class, the _AY_ tag can be omitted. The _AY_ tag must be placed directly after the _AC_ tag.

#### AF

An optional tag that specifies the frequency of a ground station that provides information on the defined airspace. The _AF_ must be placed directly after either the _AI_ tag or the _AG_ tag. If placed after the _AG_ tag, the _AG_ tag must directly be placed after the _AI_ tag. The proposed best order is _AF_, then _AG_.

#### AG

If _AF_ is present, defines the ground station name. May not be used without the _AF_ tag. The _AG_ must be placed directly after either the _AF_ tag or the _AF_ tag. If placed after the _AG_ tag, the _AF_ tag must directly be placed after the _AI_ tag. The proposed best order is _AF_, then _AG_.

Install
=
# Install

```shell
npm install -g @openaip/openair-fix-format
```

Node
=
# Node

```javascript
const fixFormat = require('@openaip/openair-fix-format');

await fixFormat.fix({in: './path/to/input-openair-file.txt', out:'./path/to/output-openair-file.txt'});
await fixFormat.fix({ in: './path/to/input-openair-file.txt', out: './path/to/output-openair-file.txt' });
```

CLI
=
# CLI

```bash
node cli.js -h
Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@
},
"homepage": "https://github.com/openAIP/openaip-openair-fix-format#readme",
"scripts": {
"test": "TZ='UTC' NODE_ENV=test jest --forceExit -c jest.config.js tests/**",
"test-watch": "TZ='UTC' NODE_ENV=test jest --forceExit -c jest.config.js tests/** --watch",
"test": "vitest run --coverage",
"lint": "eslint -c .eslintrc.js .",
"run-security-audit": "npm audit --omit=dev",
"update-packages": "ncu --target minor --upgrade --reject jsts && npm install"
"format": "prettier --plugin-search-dir . --write .",
"update-packages": "ncu --target minor --upgrade --reject jsts && npm install && npm audit fix"
},
"dependencies": {
"check-types": "^11.2.2",
Expand All @@ -45,7 +45,7 @@
"@babel/eslint-parser": "^7.19.1",
"@types/check-types": "^7.3.4",
"@types/uuid": "^8.3.4",
"@vitest/coverage-v8": "^2.1.8",
"@vitest/coverage-v8": "^2.1.8",
"@vitest/ui": "^2.1.8",
"commander": "^2.20.3",
"eslint": "^8.32.0",
Expand Down

0 comments on commit d390688

Please sign in to comment.