Bump version and updated CI scripts

.github/workflows/CI.yml

@@ -1,65 +1,60 @@
 name: CI
 on:
-  - push
-  - pull_request
+  push:
+    branches:
+      - master
+    tags: '*'
+  pull_request:
+
+concurrency:
+  # Skip intermediate builds: always.
+  # Cancel intermediate builds: only if it is a pull request build.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
+# needed to allow julia-actions/cache to delete old caches that it has created
+permissions:
+  actions: write
+  contents: read
+
 jobs:
   test:
     name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
-        version:
-          - '1.5'
-          - 'nightly'
-        os:
-          - ubuntu-latest
-          - windows-latest
+        version: ['1', '1.8', 'nightly']
+        os: [ubuntu-latest, windows-latest, macOS-latest]
         arch:
           - x64
-          - x86
+          # - aarch64
     steps:
       - uses: actions/checkout@v2
       - uses: julia-actions/setup-julia@v1
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
-      - uses: actions/cache@v1
-        env:
-          cache-name: cache-artifacts
-        with:
-          path: ~/.julia/artifacts
-          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
-          restore-keys: |
-            ${{ runner.os }}-test-${{ env.cache-name }}-
-            ${{ runner.os }}-test-
-            ${{ runner.os }}-
+      - uses: julia-actions/cache@v1
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
+        with:
+          annotate: true
       - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v1
+      - uses: codecov/codecov-action@v3
         with:
-          file: lcov.info
+          files: lcov.info
   docs:
     name: Documentation
+    permissions: write-all
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - uses: julia-actions/setup-julia@v1
         with:
           version: '1'
-      - run: |
-          julia --project=docs -e '
-            using Pkg
-            Pkg.develop(PackageSpec(path=pwd()))
-            Pkg.instantiate()'
-      - run: |
-          julia --project=docs -e '
-            using Documenter: DocMeta, doctest
-            using ReverseGeocode
-            DocMeta.setdocmeta!(ReverseGeocode, :DocTestSetup, :(using ReverseGeocode); recursive=true)
-            doctest(ReverseGeocode)'
-      - run: julia --project=docs docs/make.jl
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-docdeploy@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+          DOCUMENTER_KEY: ${{ secrets.SSH_KEY_ID_ED25519_GITHUB }}

.github/workflows/TagBot.yml

@@ -4,6 +4,22 @@ on:
     types:
       - created
   workflow_dispatch:
+    inputs:
+      lookback:
+        default: 3
+permissions:
+  actions: read
+  checks: read
+  contents: write
+  deployments: read
+  issues: read
+  discussions: read
+  packages: read
+  pages: read
+  pull-requests: read
+  repository-projects: read
+  security-events: read
+  statuses: read
 jobs:
   TagBot:
     if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
@@ -12,4 +28,4 @@ jobs:
       - uses: JuliaRegistries/TagBot@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          ssh: ${{ secrets.DOCUMENTER_KEY }}
+          ssh: ${{ secrets.SSH_KEY_ID_ED25519_GITHUB }}

.gitignore

@@ -1,8 +1,13 @@
-*.jl.*.cov
-*.jl.cov
-*.jl.mem
-/docs/build/
+# Package generated files
 /data/*
 !country_codes.csv
 
-**Manifest.toml
+# Julia generated files
+/docs/build/
+**Manifest.toml
+*.jl.mem
+*.jl.*.cov
+*.jl.cov
+
+# Dev tools
+.vscode/

Project.toml

@@ -1,7 +1,7 @@
 name = "ReverseGeocode"
 uuid = "96b87e3f-b46e-456c-8178-0e438baab6fa"
 authors = ["Jan Mrkos <[email protected]>"]
-version = "0.3.4"
+version = "4.0.0"
 
 [deps]
 CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"

README.md

@@ -45,7 +45,7 @@ Note that due to the requirements of the NearestNeighbors library, the dimension
 
 ### Decode Output Customization
 
-The user can also explicitly specify what the decode output as well. The cities data contains other additional headers (e.g., `population`, `admin1`, `modification_date`) that can be included into the output.
+The user can also explicitly specify the decode output as well. The cities data contains other additional headers (e.g., `population`, `admin1`, `modification_date`) that can be included into the output.
 
 For example, if the user wants population data from the GeoNames cities table: