Skip to content

Conversation

@dependabot
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Apr 18, 2025

Bumps com.approvaltests:approvaltests from 18.0.0 to 24.21.0.

Release notes

Sourced from com.approvaltests:approvaltests's releases.

Added FileUtils.getResolvedPath()

When working with the file ./name.txt:

getAbsolutePath() will resolve this to /path/to/./name.txt

instead of the desired /path/to/name.txt.

getResolvedPath() solves this problem.

Python scripts for remove_abandoned_files and approve_all

Also, temp folder works when running tests in multi-threaded mode

ReadBuffer input no longer modifies newlines or adds them at the end

Also: Added StringUtils.ensureEnding Added FileUtils.readFile(file, ensureTrailingNewline = true)

Closes #637

Automatically git-ignore our temp folder

Just like ApprovalTests.Python, we now write a .gitignore file into our temp directory, thus consumers of the library don't have to add the folder themselves to their project's gitignore.

Once.runAsync

Once now supports running tasks asynchronously.

Bugfix

Downloading the approve_all script now is done asynchronously, meaning it won't affect build times. Closes #615

Fixes problems with ReporterWithApprovalPower and FirstWorkingReporter

Fixes bug #446

Allow configuration of project base directory

By default, Approvals uses the working directory to find the working directory and its children to find source file and store received and approved files. This is now configurable if your working directory no longer contains the source. You can do this by setting either the system property or system environment variable called APPROVALTESTS_PROJECT_DIRECTORY. Here is an example of doing this when running tests with maven on forks:

<systemPropertyVariables>
    <APPROVALTESTS_PROJECT_DIRECTORY>${project.basedir}</APPROVALTESTS_PROJECT_DIRECTORY>
</systemPropertyVariables>

Reported in #608

Also fixes #612

Add Once object like in Golang

Once.run(() -> ... your code here ...) Will execute that code once and only once.

... (truncated)

Commits
  • 8f4212b - r update junit-jupiter to 5.12.2
  • e4818ad . d updated markdown snippets
  • 2ae7a5b - r Replaced all calls to getAbsolutePath() with FileUtils.getResolvedPath(file)
  • eac96aa - F Added FileUtils.getResolvedPath
  • 160a1d4 . e Remove unsupported Java versions
  • 34d78d2 - r Bump com.google.code.gson:gson from 2.12.1 to 2.13.0
  • 8642c3d . e build_and_test.cmd
  • 2f38f60 . C Release v24.20.0
  • f41b4a6 - B Fix how path is created for temp folder
  • de6167b . d updated markdown snippets
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Summary by Sourcery

Upgrade ApprovalTests library from version 18.0.0 to 24.21.0, incorporating multiple new features, improvements, and bug fixes

New Features:

  • Add FileUtils.getResolvedPath() for better path resolution
  • Introduce Once.runAsync for asynchronous task execution
  • Add Once.run() method for executing code only once
  • Allow configuration of project base directory via system property or environment variable

Bug Fixes:

  • Fix issues with ReporterWithApprovalPower and FirstWorkingReporter
  • Resolve path creation problems for temp folders
  • Improve ReadBuffer to no longer modify newlines

Enhancements:

  • Improve file path handling with FileUtils methods
  • Add StringUtils.ensureEnding
  • Automatically git-ignore temp folder
  • Enhance file reading capabilities

Build:

  • Update JUnit Jupiter to 5.12.2
  • Bump Gson from 2.12.1 to 2.13.0
  • Remove unsupported Java versions

Bumps [com.approvaltests:approvaltests](https://github.com/approvals/ApprovalTests.Java) from 18.0.0 to 24.21.0.
- [Release notes](https://github.com/approvals/ApprovalTests.Java/releases)
- [Commits](approvals/ApprovalTests.Java@18.0.0...24.21.0)

---
updated-dependencies:
- dependency-name: com.approvaltests:approvaltests
  dependency-version: 24.21.0
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file java Pull requests that update Java code labels Apr 18, 2025
@sourcery-ai
Copy link

sourcery-ai bot commented Apr 18, 2025

Reviewer's Guide by Sourcery

This pull request bumps the com.approvaltests:approvaltests dependency from version 18.0.0 to 24.21.0. This update is reflected in the pom.xml file.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
The pull request updates the version of the com.approvaltests:approvaltests dependency from 18.0.0 to 24.21.0.
  • Updated the com.approvaltests:approvaltests dependency version in pom.xml.
pom.xml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

We have skipped reviewing this pull request. Here's why:

  • It seems to have been created by a bot (hey, dependabot[bot]!). We assume it knows what it's doing!
  • We don't review packaging changes - Let us know if you'd like us to change this.

@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github May 13, 2025

Superseded by #33.

@dependabot dependabot bot closed this May 13, 2025
@dependabot dependabot bot deleted the dependabot/maven/com.approvaltests-approvaltests-24.21.0 branch May 13, 2025 02:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file java Pull requests that update Java code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants