Skip to content

Commit 0629ba4

Browse files
authored
Update README guidance to depend on git tags when building from source. (#134)
*Issue #, if available:* *Description of changes:* Provide some guidance on how to check out the repository for applications where build stability is important. This guidance aims to make itself superfluous as we improve our CI workflows. By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. --------- Signed-off-by: Simon Marty <[email protected]>
1 parent ab15067 commit 0629ba4

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ To build the Secrets Manager Agent binary natively, you need the standard develo
4141

4242
------
4343

44+
**NOTE:** To ensure a stable experience, use a specific git tag when building from source code. You can find a list of version tags [here](https://github.com/aws/aws-secretsmanager-agent/tags). Tags are in the pattern `/v\d+\.\d+\.\d+/` and follow [SemVer 2.0.0](https://semver.org/spec/v2.0.0.html).
45+
46+
Example: `git clone --branch <git tag> https://github.com/aws/aws-secretsmanager-agent.git`
47+
4448
**NOTE:** Building the agent with the `fips` feature enabled on macOS currently requires the following workaround:
4549

4650
- Create an environment variable called `SDKROOT` which is set to the result of running `xcrun --show-sdk-path`

0 commit comments

Comments
 (0)