Merge pull request #41 from OpenCageData/release-2.2.2

prepare release v2.2.2

.github/CONTRIBUTING.md

@@ -14,43 +14,43 @@ a duplicate.
 
 ### Bugs
 
-- Choose the "Bug Report" template
-- Fill in all relevant information, especially
-- Describe steps to reproduce
-- Full error message if any
-- Your code if relevant
+-  Choose the "Bug Report" template
+-  Fill in all relevant information, especially
+-  Describe steps to reproduce
+-  Full error message if any
+-  Your code if relevant
 
 ### Feature Requests
 
-- Choose the "Feature Request" template
-- Describe the feature. Be specific
-- Explain why I should implement it.
+-  Choose the "Feature Request" template
+-  Describe the feature. Be specific
+-  Explain why I should implement it.
 
 ## Pull Request Guidelines
 
-- Please check to make sure that there aren't existing pull requests attempting to address the issue mentioned.
-- Open a single PR for each subject.
-- Develop in a topic branch, not master (feature-name).
-- Write a convincing description of your PR and why I should land it.
-- Update documentation comments where applicable.
+-  Please check to make sure that there aren't existing pull requests attempting to address the issue mentioned.
+-  Open a single PR for each subject.
+-  Develop in a topic branch, not master (feature-name).
+-  Write a convincing description of your PR and why I should land it.
+-  Update documentation comments where applicable.
 
 ### Only touch relevant files
 
-- Make sure your PR stays focused on a single feature.
-- Don't change project configs or any files unrelated to the subject you're working.
-- Don't reformat code you don't modify.
+-  Make sure your PR stays focused on a single feature.
+-  Don't change project configs or any files unrelated to the subject you're working.
+-  Don't reformat code you don't modify.
 
 ### Fixing a bug?
 
-- Mention it or create an issue if not exist
-- Do not forgot to put [Fix # in your commit message to auto close](https://help.github.com/articles/closing-issues-via-commit-messages/)
+-  Mention it or create an issue if not exist
+-  Do not forgot to put [Fix # in your commit message to auto close](https://help.github.com/articles/closing-issues-via-commit-messages/)
 
 ### Keep your commit history short and clean.
 
-- Keeping the history clean means making one commit per feature. (no fix of your fix)
-- We may squash your PR.
+-  Keeping the history clean means making one commit per feature. (no fix of your fix)
+-  We may squash your PR.
 
 ### Make sure tests pass (if exist)
 
-- Add relevant tests to cover the change.
-- Make sure test-suite passes.
+-  Add relevant tests to cover the change.
+-  Make sure test-suite passes.

.github/ISSUE_TEMPLATE/-everything-else--report.md

@@ -1,9 +1,9 @@
 ---
 name: '"Everything else" Report'
 about: Use this if it's NOT a bug or feature request
-title: ''
-labels: ''
-assignees: ''
+title: ""
+labels: ""
+assignees: ""
 ---
 
 <!--
@@ -16,12 +16,13 @@ ATTENTION: Only issues using a filled template will be accepted!
 
 <!-- Please remove all items that are not relevant. -->
 
-- 2.2.1
-- 2.2.0
-- 2.1.0
-- 2.0.0
-- 1.4.1
-- 1.4.0
-- 1.3.0
-- 1.2.1
-- other: (Please fill in the version you are using.)
+- 2.2.2
+- 2.2.1
+- 2.2.0
+- 2.1.0
+- 2.0.0
+- 1.4.1
+- 1.4.0
+- 1.3.0
+- 1.2.1
+- other: (Please fill in the version you are using.)

.github/ISSUE_TEMPLATE/bug-report.md

@@ -1,9 +1,9 @@
 ---
 name: Bug Report
 about: Template to report bugs.
-title: 'Bug: '
-labels: ''
-assignees: ''
+title: "Bug: "
+labels: ""
+assignees: ""
 ---
 
 <!--
@@ -14,15 +14,16 @@ ATTENTION: Only issues using a filled template will be accepted!
 
 <!-- Please remove all items that are not relevant. -->
 
-- 2.2.1
-- 2.2.0
-- 2.1.0
-- 2.0.0
-- 1.4.1
-- 1.4.0
-- 1.3.0
-- 1.2.1
-- other: (Please fill in the version you are using.)
+- 2.2.2
+- 2.2.1
+- 2.2.0
+- 2.1.0
+- 2.0.0
+- 1.4.1
+- 1.4.0
+- 1.3.0
+- 1.2.1
+- other: (Please fill in the version you are using.)
 
 ### Current Behavior
 

.github/ISSUE_TEMPLATE/feature-request.md

@@ -1,9 +1,9 @@
 ---
 name: Feature Request
 about: Request a feature addition or change.
-title: 'Feat: '
-labels: ''
-assignees: ''
+title: "Feat: "
+labels: ""
+assignees: ""
 ---
 
 <!--

.github/dependabot.yml

@@ -5,7 +5,7 @@
 
 version: 2
 updates:
- - package-ecosystem: 'gradle' # See documentation for possible values
- directory: '/' # Location of package manifests
- schedule:
- interval: 'weekly'
+  - package-ecosystem: "gradle" # See documentation for possible values
+  directory: "/" # Location of package manifests
+  schedule:
+  interval: "weekly"

.github/workflows/meterian.yml

@@ -3,13 +3,13 @@ name: Meterian Scanner workflow
 on: push
 
 jobs:
- meterian_scan:
- name: Meterian client scan
- runs-on: ubuntu-latest
- steps:
- - name: Checkout
- uses: actions/checkout@v4
- - name: Meterian Scanner
- uses: MeterianHQ/meterian-github-action@v1.0.17
- with:
- oss: true
+  meterian_scan:
+  name: Meterian client scan
+  runs-on: ubuntu-latest
+  steps:
+  - name: Checkout
+  uses: actions/checkout@v4
+  - name: Meterian Scanner
+  uses: MeterianHQ/meterian-github-action@v1.0.17
+  with:
+  oss: true

.github/workflows/publish-javadoc.yml

@@ -1,20 +1,20 @@
 name: Deploy Javadoc
 
 on:
- push:
- branches:
- - master
- - main
+  push:
+  branches:
+  - master
+  - main
 
 jobs:
- publish:
- runs-on: ubuntu-latest
- steps:
- - name: Deploy JavaDoc 🚀
- uses: MathieuSoysal/Javadoc-publisher.yml@v2.5.0
- with:
- GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
- javadoc-branch: javadoc
- java-version: 17
- target-folder: javadoc
- project: gradle
+  publish:
+  runs-on: ubuntu-latest
+  steps:
+  - name: Deploy JavaDoc 🚀
+  uses: MathieuSoysal/Javadoc-publisher.yml@v2.5.0
+  with:
+  GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+  javadoc-branch: javadoc
+  java-version: 17
+  target-folder: javadoc
+  project: gradle

.github/workflows/unit-tests.yml

@@ -1,33 +1,33 @@
 name: Unit Tests workflow
 
 on:
- push:
- branches:
- - '**'
- tags-ignore:
- - '*.*'
- paths-ignore:
- - README.md
- - CHANGELOG.md
+  push:
+  branches:
+  - "**"
+  tags-ignore:
+  - "*.*"
+  paths-ignore:
+  - README.md
+  - CHANGELOG.md
 
 jobs:
- gradle_tests:
- name: Gradle test
- runs-on: ubuntu-latest
+  gradle_tests:
+  name: Gradle test
+  runs-on: ubuntu-latest
 
- steps:
- - name: Checkout latest source
- uses: actions/checkout@v4
+  steps:
+  - name: Checkout latest source
+  uses: actions/checkout@v4
 
- - name: Set up JDK 8
- uses: actions/setup-java@v4
- with:
- distribution: 'temurin'
- java-version: 8
- cache: 'gradle'
+  - name: Set up JDK 8
+  uses: actions/setup-java@v4
+  with:
+  distribution: "temurin"
+  java-version: 8
+  cache: "gradle"
 
- - name: Grant execute permission for gradlew
- run: chmod +x gradlew
+  - name: Grant execute permission for gradlew
+  run: chmod +x gradlew
 
- - name: Run Tests
- run: ./gradlew -DOPENCAGE_API_KEY=${{ secrets.OPENCAGE_API_KEY }} test
+  - name: Run Tests
+  run: ./gradlew -DOPENCAGE_API_KEY=${{ secrets.OPENCAGE_API_KEY }} test

.gitignore

@@ -101,14 +101,14 @@ local.properties
 # When using Gradle or Maven with auto-import, you should exclude module files,
 # since they will be recreated, and may cause churn. Uncomment if using
 # auto-import.
- .idea/artifacts
- .idea/compiler.xml
- .idea/jarRepositories.xml
- .idea/modules.xml
- .idea/*.iml
- .idea/modules
- *.iml
- *.ipr
+.idea/artifacts
+.idea/compiler.xml
+.idea/jarRepositories.xml
+.idea/modules.xml
+.idea/*.iml
+.idea/modules
+*.iml
+*.ipr
 
 # CMake
 cmake-build-*/

.vscode/settings.json

@@ -1,3 +1,3 @@
 {
- "java.configuration.updateBuildConfiguration": "interactive"
+  "java.configuration.updateBuildConfiguration": "interactive"
 }