You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This Go module is a collection of tools that have been written for managing the AWS SDK for Go V2 source repository.
4
+
At the time these were written, the Go ecosystem lacked tooling for managing repositories containing multiple Go modules
5
+
with at the size and scale of the AWS SDK. With over 274 Go modules in the repository the tooling found here has been
6
+
made to manage the lifecycle of managing dependencies (iter-repository and external), managing the releases of new
7
+
changes, tag management following Go semver requirements, and production of changelogs.
8
+
9
+
## Utilities
10
+
The following is a breakdown of some the key utilities found in this module that are used to manage the SDK and handle
11
+
the complex release process.
12
+
13
+
Commands | Description | README
14
+
--- | --- | ---
15
+
`changelog` | Create and manage changelog annotations. Annotations are used to document module changes and refining of the next semver version. | [Link][changelog]
16
+
`updaterequires` | Manages `go.mod` require entries, allows for easily updating inter-repository module dependencies to their latest tag, and the ability to quickly manage external dependency requirements. | N/A
17
+
`updatemodulemeta` | Generates a `go_module_metadata.go` file in each module containing useful runtime metadata like the modules tagged version. | N/A
18
+
`generatechangelog` | Uses a release description and associated changelog annotations to produce `CHANGELOG.md` entries for the release in each repository module. In addition, a summarized release statement will be created at the root of the repository. | N/A
19
+
`gomodgen` | Copies [smithy-go] codegen build artifacts into the SDK repository and generates a `go.mod` file using the build artifacts `generated.json` description. | N/A
20
+
`annotatestablegen` | Generates a release changelog annotation type for **new**[smithy-go] generated modules that are not marked as unstable. | N/A
21
+
`calculaterelease` | Detects new and changed Go modules in the repository, associates changelog annotations, and computes the next semver version tag for each module. Produces a release manifest that is used with other utilities to orchestrate a release. | [Link][calculaterelease]
22
+
`tagrelease` | Commits pending changes to the working directory, reads the release manifest, and creates the computed tags | N/A
23
+
`makerelative` | Used to generate `go.mod``replace` statements for inter-repository module dependencies. This ensures that when developing on a given Go module it's iter-repository dependencies refer to the cloned repository. | N/A
24
+
`eachmodule` | Utility for quickly scripting execution of commands in each module of a repository. | N/A
25
+
26
+
# Configuration
27
+
28
+
A number of the repository tools, specifically those involved with the dependency management and release have specific
29
+
behavior that is driven by the `modman.toml` file found at the root of the git repository. This configuration file is
30
+
a [TOML] configuration file.
31
+
32
+
## Dependencies
33
+
The `dependencies` is a dictionary of key-value pairs that describe **external** dependencies that one or more modules
34
+
within the repository may depend on. (External dependencies is defined as the set of Go modules that are not found
35
+
within the project git repository.) This section is used to quickly set the version of a dependency modules in the
36
+
repository should use. The `updaterequires` tool can be used to update all Go modules require statements for each module
37
+
in the repository and update them to the indicated version if they depend on the given external module.
38
+
39
+
### Example
40
+
```toml
41
+
[dependencies]
42
+
"github.com/aws/smithy-go" = "v1.4.0"
43
+
```
44
+
45
+
This example indicates that repository modules that depend on `github.com/aws/smithy-go` should depend on `v1.4.0`
46
+
version of the library. After updating the value in the configuration file, `updaterequires` can be used to update
47
+
modules with this information.
48
+
49
+
## Modules
50
+
51
+
`modules` is a dictionary where the keys are module directories relative to the repository root. Each key maps to a
52
+
dictionary of key-value pairs that can configure several properties of a module that affect how or
53
+
if a module is handled when performing a release.
54
+
55
+
### Example
56
+
To configure the module `feature/service/shinything` to not be tagged by the release process:
57
+
58
+
```toml
59
+
[modules."feature/service/shinything"]
60
+
no_tag = true
61
+
```
62
+
63
+
For more information on how to configure how modules are released see the [calculaterelease README][calculaterelease].
64
+
65
+
#### Mark a module to be
66
+
67
+
**NOTE**: If you wish to create a configuration item for a module located at the root of the repository use
0 commit comments