Clarify the breaking location change and the password placeholder exception in the 0.14.0 changelog

Open Beginner friendly
#198 2 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

@TharmiganK is already working on this.

Since Nov 13, 2026.

  • #202 by @TharmiganK — open
  • #203 by @TharmiganK — open

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
74/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Domain
documentation

Research direction

Start with the [Unreleased] section of the changelog, where the 0.14.0 location entry (#172, #152, #174) and the ballerina:13/ballerina:14 entry (#178, #180) are. Check the password rule descriptions for the same "for any value" wording. Done when the location entry starts with "Breaking:", the password entries say "any value that is not a placeholder", and the single-case run over 15 characters is documented as a key.

Written by the indexing model from the issue text.

Description

Type/Docs
Description

Two changelog entries in [Unreleased] (0.14.0) need clearer wording before release:

  1. The location change in scan_results.json and the JSON on standard output (one-based lines and columns, project-relative paths; #172, #152, #174) says consumers "need to be updated" but doesn't call it a breaking change. #174 describes it as a breaking change for JSON consumers. Mark it as breaking, for example by starting the entry with "Breaking:".
  2. The ballerina:13/ballerina:14 entry (#178, #180) says passwords are reported "for any value", but placeholders are still skipped: a one-character value ("a", "*"), a repeated character ("xxxxxxxx") or "changeme". The full rule descriptions use the same wording. Say "any value that is not a placeholder". A related case worth documenting: a single-case run longer than 15 characters, such as "correcthorsebatterystaple", is not treated as words (to catch base32 keys), so it is reported as a key.

Found while testing v0.14.0 (#186).

Version

0.14.0

Dominant language
Java
Stars
15
Forks
12
Avg merge
2d 8h
Merged PRs (30d)
29

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ballerina-platform/static-code-analysis-tool

All issues in ballerina-platform/static-code-analysis-tool

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.