diff --git a/.github/workflows/greetings.yml b/.github/workflows/greetings.yml deleted file mode 100644 index bfd82b94..00000000 --- a/.github/workflows/greetings.yml +++ /dev/null @@ -1,16 +0,0 @@ -name: Greetings - -on: [pull_request_target, issues] - -jobs: - greeting: - runs-on: ubuntu-latest - permissions: - issues: write - pull-requests: write - steps: - - uses: actions/first-interaction@v1 - with: - repo-token: ${{ secrets.GITHUB_TOKEN }} - issue-message: 'Thank you for creating your first issue in this repository. We appreciate your contribution and will review it as soon as possible.' - pr-message: 'Thank you for creating your first pull request in this repository. We appreciate your contribution and will review it as soon as possible.' diff --git a/.github/workflows/maven-publish.yml b/.github/workflows/maven-publish.yml index 0ec433cb..93d1fc87 100644 --- a/.github/workflows/maven-publish.yml +++ b/.github/workflows/maven-publish.yml @@ -28,7 +28,7 @@ jobs: - name: Release With Maven run: | - mvn -s settings.xml -Dgpg.passphrase=${{ secrets.OSSRH_GPG_SECRET_KEY_PASSWORD }} --batch-mode deploy -DskipTests + mvn -s settings.xml -Dgpg.passphrase=${{ secrets.OSSRH_GPG_SECRET_KEY_PASSWORD }} --batch-mode deploy -DskipTests -P publish env: MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }} MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }} diff --git a/.github/workflows/qodana.yml b/.github/workflows/qodana.yml deleted file mode 100644 index 41d1eb97..00000000 --- a/.github/workflows/qodana.yml +++ /dev/null @@ -1,45 +0,0 @@ -name: Qodana -on: - workflow_dispatch: - pull_request: - push: - branches: - - main - - 'releases/*' - -jobs: - qodana: - name: Build and analyze - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - with: - ref: ${{ github.event.pull_request.head.sha }} # to check out the actual pull request commit, not the merge commit - fetch-depth: 0 # a full history is required for pull request analysis - - name: Set up JDK 17 - uses: actions/setup-java@v3 - with: - java-version: 17 - distribution: 'zulu' # Alternative distribution options are available. - - name: Cache Maven packages - uses: actions/cache@v3 - with: - path: ~/.m2 - key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }} - restore-keys: ${{ runner.os }}-m2 - - name: Build and analyze - run: mvn -B clean verify -P coverage - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - name: Archive coverage data - uses: actions/upload-artifact@v2 - with: - name: maven-coverage-data-jacoco - path: target/site/jacoco - - name: Qodana Scan - uses: JetBrains/qodana-action@main - env: - QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }} - with: - args: "-i,JVM/jacoco/maven,--linter,jetbrains/qodana-jvm:2023.3-eap" - pr-mode: false diff --git a/.licrc b/.licrc new file mode 100644 index 00000000..5d1a018e --- /dev/null +++ b/.licrc @@ -0,0 +1,11 @@ +[licenses] +accepted = ["Apache-2.0", "MIT", "MSC", "BSD"] + +[dependencies] +ignored=["ignored_dep1", "ignored_dep2"] +ignore_dev_dependencies = true +ignore_optional_dependencies = true + +[behavior] +run_only_on_dependency_modification = true +do_not_block_pr = false diff --git a/README.md b/README.md index 21a9c3d1..d496391f 100644 --- a/README.md +++ b/README.md @@ -102,13 +102,8 @@ libraryDependencies += "io.github.brenoepics" % "at4j" % "1.0.0" **A:** You can access your Azure Translator Keys through your Azure portal. Remember to keep your keys secure and refrain from sharing them publicly. If you suspect a key has been compromised, it's crucial to regenerate it promptly. For detailed instructions on generating your own keys, refer to [this guide](https://brenoepics.github.io/at4j/guide/azure-subscription.html#azure-subscription). Additionally, you can explore the [Azure Free Tier](https://brenoepics.github.io/at4j/guide/azure-subscription.html#azure-free-tier) for more information. -Optional Logger Dependency -**Q:** Is there a recommended logger dependency for the project? - -**A:** While our project is compatible with any Log4j-2-compatible logging framework, integrating one can enhance your logging experience significantly. This allows you to configure log format, log targets (console, file, database, etc.), log levels per class, and more. For further details, please visit our [Docs](https://brenoepics.github.io/at4j/guide/installation.html#logger-dependency). - ## 🤝 Thank You! -- **Microsoft Azure**: Supporting our project with a generous grant of $10,000+ in Azure credits, enabling us to utilize virtual machines, document translation and other essential cloud resources for our development needs. +- **Microsoft Azure**: Supporting our project with a generous grant of $10,000+ in Azure credits, enabling us to use virtual machines, document translation and other essential cloud resources for our development needs. - We extend our sincere thanks to all contributors for their invaluable contributions. ## 🧑‍💻 Contributing diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 887e8822..f78875df 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -1,5 +1,5 @@ -import { defineConfigWithTheme } from 'vitepress' -import type { ThemeConfig } from 'vitepress-carbon' +import {defineConfigWithTheme} from 'vitepress' +import type {ThemeConfig} from 'vitepress-carbon' import baseConfig from 'vitepress-carbon/config' const nav = [ @@ -7,19 +7,19 @@ const nav = [ text: 'Docs', activeMatch: `^/(guide|examples)/`, items: [ - { text: 'Guide', link: '/guide/introduction' }, - { text: 'Examples', link: '/examples/' }, - { text: 'Error Reference', link: '/error-reference/' }, - { text: 'JavaDoc', link: 'https://brenoepics.github.io/at4j/javadoc/' } + {text: 'Guide', link: '/guide/introduction'}, + {text: 'Examples', link: '/examples/'}, + {text: 'Error Reference', link: '/error-reference/'}, + {text: 'JavaDoc', link: 'https://brenoepics.github.io/at4j/javadoc/'} ] }, { text: 'About', activeMatch: `^/about/`, items: [ - { text: 'FAQ', link: '/about/faq' }, - { text: 'Releases', link: '/about/releases' }, - { text: 'Code of Conduct', link: '/about/coc' } + {text: 'FAQ', link: '/about/faq'}, + {text: 'Releases', link: '/about/releases'}, + {text: 'Code of Conduct', link: '/about/coc'} ] }, ] @@ -28,7 +28,7 @@ const sidebar = { { text: 'Getting Started', items: [ - { text: 'Introduction', link: '/guide/introduction' }, + {text: 'Introduction', link: '/guide/introduction'}, { text: 'Download/Installation', link: '/guide/installation' @@ -41,6 +41,10 @@ const sidebar = { text: 'Basic Usage', link: '/guide/basic-usage' }, + { + text: 'Threading', + link: '/guide/threading' + }, { text: 'Examples', link: '/examples/' @@ -79,10 +83,10 @@ export default defineConfigWithTheme({ base: '/at4j/', head: [ - ['meta', { name: 'theme-color', content: '#3c8772' }], - ['meta', { property: 'og:url', content: 'https://github.com/brenoepics/at4j' }], - ['meta', { property: 'og:type', content: 'Repository' }], - ['meta', { property: 'og:title', content: 'AT4J' }], + ['meta', {name: 'theme-color', content: '#3c8772'}], + ['meta', {property: 'og:url', content: 'https://github.com/brenoepics/at4j'}], + ['meta', {property: 'og:type', content: 'Repository'}], + ['meta', {property: 'og:title', content: 'AT4J'}], [ 'meta', { @@ -109,7 +113,7 @@ export default defineConfigWithTheme({ }, link: 'https://www.postman.com/maintenance-astronaut-2993290/workspace/brenoepics/collection/18589822-dfe7a640-9b94-47a8-b19f-46cb9cc8843e?action=share&creator=18589822' }, - { icon: 'github', link: 'https://github.com/brenoepics/at4j' } + {icon: 'github', link: 'https://github.com/brenoepics/at4j'} ], diff --git a/docs/package.json b/docs/package.json index 210dc45c..1ac9be63 100644 --- a/docs/package.json +++ b/docs/package.json @@ -8,6 +8,6 @@ "preview": "vitepress preview" }, "dependencies": { - "vitepress-carbon": "1.0.2" + "vitepress-carbon": "latest" } } diff --git a/docs/src/error-reference/ErrorsTable.vue b/docs/src/error-reference/ErrorsTable.vue index 73a7d87e..add765dd 100644 --- a/docs/src/error-reference/ErrorsTable.vue +++ b/docs/src/error-reference/ErrorsTable.vue @@ -8,6 +8,7 @@ defineProps<{