opensearch-dashboards-3/3.1.0 package update

[octo-sts]

[octo-sts]

🔄 Build Failed: Git Checkout Error

FAIL Expected commit 93296ec81611080141bc569f761794a01eb1d105 for 3.1.0, found c152d16bbe6b4501e3e2418be0f9f8b3dc07559f

Build Details

Category	Details
Build System	Melange (Wolfi Linux package builder)
Failure Point	git checkout for opensearch-dashboards-3-config subpackage

Root Cause Analysis 🔍

The build is trying to check out a specific commit (93296ec81611080141bc569f761794a01eb1d105) from tag 3.1.0 of the opensearch-build repository, but the actual commit hash for that tag is different (c152d16bbe6b4501e3e2418be0f9f8b3dc07559f). This mismatch causes the build to fail because the expected commit doesn't match the actual commit associated with the tag.

---

🔍 Build failure fix suggestions

Found similar build failures that have been fixed in the past and analyzed them to suggest a fix:

Similar PRs with fixes

• Adding VersionStream for gitlab-runner-17.11 #51032
• opensearch-dashboards-2/2.19.1 package update #44237
• gitlab-runner-17.11/17.11.1 package update #52449

Suggested Changes

File: opensearch-dashboards-3.yaml

• replacement at line expected-commit line in the opensearch-build git-checkout section (opensearch-dashboards-3-config subpackage git-checkout section)
  Original:

          expected-commit: 93296ec81611080141bc569f761794a01eb1d105 # will need to be manually updated when opensearch dashboard auto update happens

Replacement:

          expected-commit: c152d16bbe6b4501e3e2418be0f9f8b3dc07559f # will need to be manually updated when opensearch dashboard auto update happens

Click to expand fix analysis

Analysis

Looking at the similar fixed issues, there's a consistent pattern with git checkout failures where the expected commit hash doesn't match the actual commit hash at a specified tag. All three examples show the same fix approach: updating the expected-commit hash in the git-checkout section to match the actual commit hash that exists at the specified tag. This is a common issue in package build systems that pin to specific commit hashes - when the upstream repository updates their tags (possibly through a force push or tag change), the expected commit hash in the build configuration becomes outdated and must be updated to match reality.

Click to expand fix explanation

Explanation

The build failure occurs because the package is trying to check out a specific commit (93296ec81611080141bc569f761794a01eb1d105) for tag 3.1.0 in the opensearch-build repository, but the actual commit associated with that tag is different (c152d16bbe6b4501e3e2418be0f9f8b3dc07559f). This mismatch causes the git checkout to fail with the specific error message.

The error is in the opensearch-dashboards-3-config subpackage section where we're checking out the opensearch-build repository. All we need to do is update the expected-commit hash to match the actual commit hash that's associated with the tag 3.1.0 in the opensearch-build repository. This is a common situation when upstream repositories update their tags after we've created our build configuration.

Looking at all three similar fixed examples, they addressed the same type of error by updating the expected-commit hash to match the actual commit hash found at the tag. This is a straightforward fix that aligns our build expectations with the current state of the upstream repository.

The comment in the code "# will need to be manually updated when opensearch dashboard auto update happens" even acknowledges that this value needs manual updates periodically.

Click to expand alternative approaches

Alternative Approaches

• Instead of hardcoding the commit hash, the build system could fetch the latest commit hash for the specified tag at build time and use that, eliminating the need for manual updates when tags change.
• The package could be modified to verify the tag exists but not enforce a specific commit, though this would be less deterministic and could lead to unexpected behavior if the tag is moved.
• Add a pre-build verification step that checks if the expected commit matches the actual commit for the tag, and automatically updates the value or provides a clear message about what needs to be updated.

---

Was this comment helpful? Please use 👍 or 👎 reactions on this comment.

[dnegreira]

malscan report

opensearch-dashboards-3-malscan.txt

[stevebeattie]

I ran malcontent locally against all the packages built from the source, and there were no critical findings.