Improve building process with cache goes dependencies

[khanhntd]

Description: <Describe what has changed.

• Goal: To boost up the process of delivering a build process when doing a CI.
• Link to tracking Issue: Cach Dependencies when CI #688

Testing: Did three tests with the caches and make test turns from 4m to 25s and make build turns from 20m to roughly 2

• Image below is one of the testing results:
  
• Image below is the original time:
  

Documentation:

• Understand the configuration for caches better: https://markphelps.me/2019/11/speed-up-your-go-builds-with-actions-cache/
• Sample codes depend on OS: https://github.com/actions/cache/blob/main/examples.md#go---modules
• Why using go mod download instead of go get: https://stackoverflow.com/questions/66356034/what-is-the-difference-between-go-get-command-and-go-mod-download-command

Contribution: Thanks Seth and Jeffrey for helping me with all the documents and samples codes:

[anuraaga]

These aren't only dependencies but build cache too so don't need to mention the word dependencies

[sethAmazon]

This will cache tests. Do we want to do that? I would say yes since tests related to changed files will rerun if files are changed.

[sethAmazon]

This will only be caching unit tests I think. Not the integration tests.

[sethAmazon]

You might want to create conditionals to cache the build only on pr not on merge

[jefchien]

This will only be caching unit tests I think. Not the integration tests.

Yep, the integration tests aren't run using go test, so the caching wouldn't affect them. Will this cache tests though? I thought based on the documentation, the options we use with make test will prevent caching. https://pkg.go.dev/cmd/go/internal/test

The rule for a match in the cache is that the run involves the same
test binary and the flags on the command line come entirely from a
restricted set of 'cacheable' test flags, defined as -benchtime, -cpu,
-list, -parallel, -run, -short, and -v. If a run of go test has any test
or non-test flags outside this set, the result is not cached. To
disable test caching, use any test flag or argument other than the
cacheable flags.

aws-otel-collector/Makefile

Line 28 in 9153ede

GOTEST_OPT?= -short -coverprofile coverage.txt -v -race -timeout 180s

[sethAmazon]

Yes you are right

[anuraaga]

We don't need this step, the build will automatically download needed dependencies and they'll be cached anyways. go mod download tends to download more than actually needed for the build.

[khanhntd]

Interesting thought !!!. Will change this in the upcoming commit

[Aneurysm9]

This doesn't do anything, does it? Since nothing will ever store in the cache with this key there will never be anything to restore.

Suggested change

	restore-keys: |
	${{ runner.os }}-go-

[khanhntd]

Yes it does. The restore-keys are the partial key, not the full key itself. What the flow actually is:

1. When there is an event that has the exact match, the actions restore the file in the cache file
2. If there are no exact matches, the action searches for partial matches of the restore keys. When the action finds a partial match, the most recent cache is restored to the path directory.
   Here is the document that states my respond:
   https://docs.github.com/en/actions/advanced-guides/caching-dependencies-to-speed-up-workflows#example-using-the-cache-action

[khanhntd]

After thinking about cache behaviors, IMO it should be removed since we don't want to cache the old modules.

[codecov-commenter]

Codecov Report

Merging #689 (a434923) into main (9153ede) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #689   +/-   ##
=======================================
  Coverage   54.54%   54.54%           
=======================================
  Files          11       11           
  Lines         297      297           
=======================================
  Hits          162      162           
  Misses        118      118           
  Partials       17       17           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9153ede...a434923. Read the comment docs.

[jefchien]

Reminder to remove after testing.

[khanhntd]

Yes removing it for the final commit.