Skip to content

Commit

Permalink
Merge pull request #41 from OpenCageData/release-2.2.2
Browse files Browse the repository at this point in the history
prepare release v2.2.2
  • Loading branch information
tsamaya authored Aug 16, 2024
2 parents 9717719 + 574c25b commit fa389cb
Show file tree
Hide file tree
Showing 15 changed files with 157 additions and 148 deletions.
44 changes: 22 additions & 22 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
25 changes: 13 additions & 12 deletions .github/ISSUE_TEMPLATE/-everything-else--report.md
Original file line number Diff line number Diff line change
@@ -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: ""
---

<!--
Expand All @@ -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.)
25 changes: 13 additions & 12 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
name: Bug Report
about: Template to report bugs.
title: 'Bug: '
labels: ''
assignees: ''
title: "Bug: "
labels: ""
assignees: ""
---

<!--
Expand All @@ -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

Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
name: Feature Request
about: Request a feature addition or change.
title: 'Feat: '
labels: ''
assignees: ''
title: "Feat: "
labels: ""
assignees: ""
---

<!--
Expand Down
8 changes: 4 additions & 4 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
20 changes: 10 additions & 10 deletions .github/workflows/meterian.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/[email protected]
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/[email protected]
with:
oss: true
30 changes: 15 additions & 15 deletions .github/workflows/publish-javadoc.yml
Original file line number Diff line number Diff line change
@@ -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/[email protected]
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/[email protected]
with:
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
javadoc-branch: javadoc
java-version: 17
target-folder: javadoc
project: gradle
48 changes: 24 additions & 24 deletions .github/workflows/unit-tests.yml
Original file line number Diff line number Diff line change
@@ -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
16 changes: 8 additions & 8 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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-*/
Expand Down
3 changes: 2 additions & 1 deletion .idea/misc.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"java.configuration.updateBuildConfiguration": "interactive"
"java.configuration.updateBuildConfiguration": "interactive"
}
Loading

0 comments on commit fa389cb

Please sign in to comment.