Skip to content

docs: update docs ahead of 1.4 release.#110

Merged
driessamyn merged 1 commit into
mainfrom
docs-1.4
Apr 25, 2025
Merged

docs: update docs ahead of 1.4 release.#110
driessamyn merged 1 commit into
mainfrom
docs-1.4

Conversation

@driessamyn
Copy link
Copy Markdown
Owner

No description provided.

Copilot AI review requested due to automatic review settings April 25, 2025 07:58
@qodo-free-for-open-source-projects
Copy link
Copy Markdown

qodo-free-for-open-source-projects Bot commented Apr 25, 2025

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Fix broken link

The GitHub Packages link appears to be a relative path rather than a proper URL.
Consider updating it to a full URL that points to the GitHub Packages
repository.

README.md [49]

-Snapshot releases are published from the main branch to [GitHub Packages](packages/2353016).
+Snapshot releases are published from the main branch to [GitHub Packages](https://github.com/driessamyn/kapper/packages/2353016).
  • Apply this suggestion
Suggestion importance[1-10]: 8

__

Why: The suggestion correctly identifies a broken link in the README. The current link uses a relative path format that won't work properly on GitHub. Replacing it with the full URL ensures users can access the packages repository, which is important for project adoption and usability.

Medium
  • Update

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the documentation ahead of the 1.4 release by improving descriptions, expanding integration test coverage details, and revising the roadmap items.

  • Corrected a typo in the description regarding SQL usage.
  • Expanded and clarified the integration tests and supported databases section with command examples.
  • Updated the roadmap items with new bullet points and details (e.g. transaction syntax sugar, integration tests, and auto-mapping for records).

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
- [ ] Improve and additional support for date/time conversion.
- [ ] Support DTO argument for `execute`.
- [ ] Add support for non-blocking JDBC drivers.
- [ ] Bulk operations support
Copy link

Copilot AI Apr 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] This bullet appears to be a duplicate of an existing roadmap item. Consider removing or consolidating to avoid repetition.

Copilot uses AI. Check for mistakes.
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 25, 2025

Test Results

 43 files  ±0   43 suites  ±0   35s ⏱️ ±0s
396 tests ±0  396 ✅ ±0  0 💤 ±0  0 ❌ ±0 
517 runs  ±0  517 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 4519447. ± Comparison against base commit 3766ae1.

This pull request removes 42 and adds 41 tests. Note that renamed tests count towards both.

net.samyn.kapper.internal.QueryParserTest ‑ [5] 
net.samyn.kapper.internal.SQLTypesConverterTest ‑ [10] LONGNVARCHAR, LONGNVARCHAR, net.samyn.kapper.internal.SQLTypesConverterTest$Companion$$Lambda$894/0x00007effc0506ce0@318de1d7
net.samyn.kapper.internal.SQLTypesConverterTest ‑ [11] INSTANT, net.samyn.kapper.internal.SQLTypesConverterTest$Companion$$Lambda$771/0x00007effc04b8b40@1d8cdfb1
net.samyn.kapper.internal.SQLTypesConverterTest ‑ [11] LONGVARCHAR, LONGVARCHAR, net.samyn.kapper.internal.SQLTypesConverterTest$Companion$$Lambda$895/0x00007effc0506f08@613a9c9b
net.samyn.kapper.internal.SQLTypesConverterTest ‑ [12] DATE, net.samyn.kapper.internal.SQLTypesConverterTest$Companion$$Lambda$772/0x00007effc04b8d68@1b1f8f42
net.samyn.kapper.internal.SQLTypesConverterTest ‑ [12] NCHAR, NCHAR, net.samyn.kapper.internal.SQLTypesConverterTest$Companion$$Lambda$896/0x00007effc0507130@5ede21d4
net.samyn.kapper.internal.SQLTypesConverterTest ‑ [13] LOCALDATE, net.samyn.kapper.internal.SQLTypesConverterTest$Companion$$Lambda$773/0x00007effc04b8f90@76478d14
net.samyn.kapper.internal.SQLTypesConverterTest ‑ [13] NCLOB, NCLOB, net.samyn.kapper.internal.SQLTypesConverterTest$Companion$$Lambda$897/0x00007effc0507358@34c7653f
net.samyn.kapper.internal.SQLTypesConverterTest ‑ [14] LOCALDATETIME, net.samyn.kapper.internal.SQLTypesConverterTest$Companion$$Lambda$774/0x00007effc04b91b8@78beac9f
…
net.samyn.kapper.internal.QueryParserTest ‑ [5] 

net.samyn.kapper.internal.SQLTypesConverterTest ‑ [10] LONGNVARCHAR, LONGNVARCHAR, net.samyn.kapper.internal.SQLTypesConverterTest$Companion$$Lambda$885/0x00007fe134506e10@2a62c164
net.samyn.kapper.internal.SQLTypesConverterTest ‑ [11] INSTANT, net.samyn.kapper.internal.SQLTypesConverterTest$Companion$$Lambda$795/0x00007fe1344ce4a0@2c04dc2f
net.samyn.kapper.internal.SQLTypesConverterTest ‑ [11] LONGVARCHAR, LONGVARCHAR, net.samyn.kapper.internal.SQLTypesConverterTest$Companion$$Lambda$886/0x00007fe134507038@5bf88ec5
net.samyn.kapper.internal.SQLTypesConverterTest ‑ [12] DATE, net.samyn.kapper.internal.SQLTypesConverterTest$Companion$$Lambda$796/0x00007fe1344ce6c8@7f6f174
net.samyn.kapper.internal.SQLTypesConverterTest ‑ [12] NCHAR, NCHAR, net.samyn.kapper.internal.SQLTypesConverterTest$Companion$$Lambda$887/0x00007fe134507260@4d95ba40
net.samyn.kapper.internal.SQLTypesConverterTest ‑ [13] LOCALDATE, net.samyn.kapper.internal.SQLTypesConverterTest$Companion$$Lambda$797/0x00007fe1344ce8f0@2081087
net.samyn.kapper.internal.SQLTypesConverterTest ‑ [13] NCLOB, NCLOB, net.samyn.kapper.internal.SQLTypesConverterTest$Companion$$Lambda$888/0x00007fe134507488@4a212fd5
net.samyn.kapper.internal.SQLTypesConverterTest ‑ [14] LOCALDATETIME, net.samyn.kapper.internal.SQLTypesConverterTest$Companion$$Lambda$798/0x00007fe1344ceb18@2a3f9654
net.samyn.kapper.internal.SQLTypesConverterTest ‑ [14] NVARCHAR, NVARCHAR, net.samyn.kapper.internal.SQLTypesConverterTest$Companion$$Lambda$889/0x00007fe1345076b0@1b627390
…

♻️ This comment has been updated with latest results.

@github-actions
Copy link
Copy Markdown

Code Coverage

Total Project Coverage 98.70%

@qodo-free-for-open-source-projects
Copy link
Copy Markdown

qodo-free-for-open-source-projects Bot commented Apr 25, 2025

CI Feedback 🧐

(Feedback updated until commit 36de9b6)

A test triggered by this PR failed. Here is an AI-generated analysis of the failure:

Action: Build and run tests

Failed stage: Run webiny/action-conventional-commits@v1.3.0 [❌]

Failure summary:

The action failed because some commit messages do not follow the Conventional Commits specification.
Specifically, three commits with the message "Update README.md" (lines 189, 191, and 193) are not
properly formatted according to the conventional commits standard, which requires a type prefix
(like feat:, fix:, etc.). The allowed commit types are: feat, fix, docs, style, refactor, test,
build, perf, ci, chore, revert, merge, wip.

Relevant error logs:
1:  ##[group]Operating System
2:  Ubuntu
...

181:  44bcd08fcea3ddff892067adcce9c85d89565374
182:  ##[group]Run webiny/action-conventional-commits@v1.3.0
183:  with:
184:  allowed-commit-types: feat,fix,docs,style,refactor,test,build,perf,ci,chore,revert,merge,wip
185:  ##[endgroup]
186:  ℹ️ Checking if commit messages are following the Conventional Commits specification...
187:  ##[group]Commit messages:
188:  ✅ docs: update docs ahead of 1.4 release.
189:  🚩 Update README.md
190:  Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
191:  🚩 Update README.md
192:  Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
193:  🚩 Update README.md
194:  Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
195:  ##[endgroup]
196:  ##[error]🚫 According to the conventional-commits specification, some of the commit messages are not valid.
197:  ##[group]Run actions/upload-artifact@v4
...

203:  compression-level: 6
204:  overwrite: false
205:  include-hidden-files: false
206:  ##[endgroup]
207:  ##[warning]No files were found with the provided path: **/build/test-results/*/TEST-*.xml. No artifacts will be uploaded.
208:  ##[group]Run EnricoMi/publish-unit-test-result-action@v2
209:  with:
210:  files: **/build/test-results/*/TEST-*.xml
211:  
212:  github_token: ***
213:  github_token_actor: github-actions
214:  github_retries: 10
215:  ssl_verify: true
216:  check_name: Test Results
217:  comment_mode: always
218:  fail_on: test failures
219:  action_fail: false
220:  action_fail_on_inconclusive: false
221:  time_unit: seconds
222:  report_suite_logs: none
223:  ignore_runs: false
224:  check_run: true
225:  job_summary: true
226:  compare_to_earlier_commit: true
227:  pull_request_build: merge
228:  check_run_annotations: all tests, skipped tests
229:  seconds_between_github_reads: 0.25
230:  seconds_between_github_writes: 2.0
231:  json_thousands_separator:  
232:  json_suite_details: false
233:  json_test_case_results: false
234:  search_pull_requests: false
235:  ##[endgroup]
236:  ##[command]/usr/bin/docker run --name ghcrioenricomipublishunittestresultactionv2190_190327 --label b925c2 --workdir /github/workspace --rm -e "INPUT_FILES" -e "INPUT_GITHUB_TOKEN" -e "INPUT_GITHUB_TOKEN_ACTOR" -e "INPUT_GITHUB_RETRIES" -e "INPUT_SSL_VERIFY" -e "INPUT_COMMIT" -e "INPUT_CHECK_NAME" -e "INPUT_COMMENT_TITLE" -e "INPUT_COMMENT_MODE" -e "INPUT_FAIL_ON" -e "INPUT_ACTION_FAIL" -e "INPUT_ACTION_FAIL_ON_INCONCLUSIVE" -e "INPUT_JUNIT_FILES" -e "INPUT_NUNIT_FILES" -e "INPUT_XUNIT_FILES" -e "INPUT_TRX_FILES" -e "INPUT_TIME_UNIT" -e "INPUT_TEST_FILE_PREFIX" -e "INPUT_REPORT_INDIVIDUAL_RUNS" -e "INPUT_REPORT_SUITE_LOGS" -e "INPUT_DEDUPLICATE_CLASSES_BY_FILE_NAME" -e "INPUT_LARGE_FILES" -e "INPUT_IGNORE_RUNS" -e "INPUT_CHECK_RUN" -e "INPUT_JOB_SUMMARY" -e "INPUT_COMPARE_TO_EARLIER_COMMIT" -e "INPUT_PULL_REQUEST_BUILD" -e "INPUT_EVENT_FILE" -e "INPUT_EVENT_NAME" -e "INPUT_TEST_CHANGES_LIMIT" -e "INPUT_CHECK_RUN_ANNOTATIONS" -e "INPUT_CHECK_RUN_ANNOTATIONS_BRANCH" -e "INPUT_SECONDS_BETWEEN_GITHUB_READS" -e "INPUT_SECONDS_BETWEEN_GITHUB_WRITES" -e "INPUT_SECONDARY_RATE_LIMIT_WAIT_SECONDS" -e "INPUT_JSON_FILE" -e "INPUT_JSON_THOUSANDS_SEPARATOR" -e "INPUT_JSON_SUITE_DETAILS" -e "INPUT_JSON_TEST_CASE_RESULTS" -e "INPUT_SEARCH_PULL_REQUESTS" -e "HOME" -e "GITHUB_JOB" -e "GITHUB_REF" -e "GITHUB_SHA" -e "GITHUB_REPOSITORY" -e "GITHUB_REPOSITORY_OWNER" -e "GITHUB_REPOSITORY_OWNER_ID" -e "GITHUB_RUN_ID" -e "GITHUB_RUN_NUMBER" -e "GITHUB_RETENTION_DAYS" -e "GITHUB_RUN_ATTEMPT" -e "GITHUB_ACTOR_ID" -e "GITHUB_ACTOR" -e "GITHUB_WORKFLOW" -e "GITHUB_HEAD_REF" -e "GITHUB_BASE_REF" -e "GITHUB_EVENT_NAME" -e "GITHUB_SERVER_URL" -e "GITHUB_API_URL" -e "GITHUB_GRAPHQL_URL" -e "GITHUB_REF_NAME" -e "GITHUB_REF_PROTECTED" -e "GITHUB_REF_TYPE" -e "GITHUB_WORKFLOW_REF" -e "GITHUB_WORKFLOW_SHA" -e "GITHUB_REPOSITORY_ID" -e "GITHUB_TRIGGERING_ACTOR" -e "GITHUB_WORKSPACE" -e "GITHUB_ACTION" -e "GITHUB_EVENT_PATH" -e "GITHUB_ACTION_REPOSITORY" -e "GITHUB_ACTION_REF" -e "GITHUB_PATH" -e "GITHUB_ENV" -e "GITHUB_STEP_SUMMARY" -e "GITHUB_STATE" -e "GITHUB_OUTPUT" -e "RUNNER_OS" -e "RUNNER_ARCH" -e "RUNNER_NAME" -e "RUNNER_ENVIRONMENT" -e "RUNNER_TOOL_CACHE" -e "RUNNER_TEMP" -e "RUNNER_WORKSPACE" -e "ACTIONS_RUNTIME_URL" -e "ACTIONS_RUNTIME_TOKEN" -e "ACTIONS_CACHE_URL" -e "ACTIONS_RESULTS_URL" -e GITHUB_ACTIONS=true -e CI=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/_temp/_runner_file_commands":"/github/file_commands" -v "/home/runner/work/kapper/kapper":"/github/workspace" ghcr.io/enricomi/publish-unit-test-result-action:v2.19.0
237:  2025-04-25 08:25:39 +0000 - publish -  INFO - Available memory to read files: 14.5 GiB

@sonarqubecloud
Copy link
Copy Markdown

@driessamyn driessamyn merged commit 1e90f8a into main Apr 25, 2025
5 checks passed
@driessamyn driessamyn deleted the docs-1.4 branch April 25, 2025 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants