apache / apache/maven-build-cache-extension

[MBUILDCACHE-98] Clarify literature on recommended scenarios (prod builds specifically)

Open
#325 0 comments 0 reactions 0 assignees View on GitHub
priority:major
Dominant language
Java
Stars
163
Forks
77
Avg merge
1d 2h
Merged PRs (30d)
4

Description

**[Pedro Javier Martos Velasco](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=JIRAUSER304898)** opened **[MBUILDCACHE-98](https://issues.apache.org/jira/browse/MBUILDCACHE-98?redirect=false)** and commented

Hi team,

we're experimenting with the extension in a number of projects, both internal and customer facing. It's working quite fine, in fact we're so satisfied with the result that we're in conversations to standardise its usage throughout the engineering department.

In our CI/CD implementations, any artifacts produced as part of a build are tested for functional correctness via post-deployment integration and/or e2e tests. This applies to both artifacts produced from "old style" `mvn` builds as well as artifacts produced in scope of partially or totally cached builds. These artifacts routinely make all the way to production with no issues and no impact to our customers, neither internal nor external.

That being said, we have stumbled upon this part of the [documentation](https://maven.apache.org/extensions/maven-build-cache-extension/index.html) that has raised some concerns:

!screenshot.png!

Specifically, we'd like to understand the rationale behind the very last line of that section. It would be great if you folks could share some scenarios that you may have identified for which the outcome of a cached build might not be 100% production grade. Was that line perhaps intended as a "do your due diligence" kind of disclaimer, or do you foresee or have experienced issues that make you hesitant to showcase the build cache extension as a tool fit for production usage?

We would greatly appreciate if you could elaborate a bit, as we believe that line, as it is stated right now, might limit the tool's adoption to the work done in local developer workstations, which is a bit unfortunate as we believe the cache extension could make a much greater difference and go much further than that.

Thanks, and keep up the great work!

---

**Attachments:**
- [screenshot.png](https://issues.apache.org/jira/secure/attachment/13069574/screenshot.png) (_49.48 kB_)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the Maven Build Cache Extension documentation section linked in the issue and inspect the attached screenshot to identify the final production-build disclaimer. Research the rationale and concrete cached-build scenarios behind it, then update the documentation so its production guidance is explicit and actionable.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.