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
Copy file name to clipboardExpand all lines: docs/src/content/docs/07-process/03-releases.mdx
+5-8Lines changed: 5 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,9 +38,9 @@ To release a new version of Terragrunt:
38
38
39
39
4. Set the release title to the version tag (e.g., `v1.0.2`).
40
40
41
-
5. Click **Save draft**. This automatically triggers the Release workflow via the `release: created` event.
41
+
5. Click **Save draft**.
42
42
43
-
6.Monitor the [GitHub Actions workflow run](https://github.com/gruntwork-io/terragrunt/actions/workflows/release.yml). It will:
43
+
6.Trigger the [Release workflow](https://github.com/gruntwork-io/terragrunt/actions/workflows/release.yml) via **Run workflow**, providing the version string you just drafted (e.g., `v1.0.2`). The workflow looks up the draft release, reads its target commit SHA, and will:
44
44
- Validate the tag is a valid semantic version
45
45
- Verify the target is a commit SHA (not a branch name)
46
46
- Build binaries for every supported OS and architecture
@@ -52,8 +52,8 @@ To release a new version of Terragrunt:
52
52
53
53
8. Write or finalize the release notes.
54
54
55
-
<Asidetype="caution"title="Editing a draft triggers a rebuild">
56
-
Editing a draft release (other than just updating the release notes) will re-trigger the build workflow to ensure assets always match the current release configuration. Release note edits alone do not trigger a rebuild.
55
+
<Asidetype="note"title="Re-running after edits">
56
+
If you edit the draft (for example, to retarget a new commit SHA), re-run the Release workflow with the same version to rebuild and overwrite the assets. Editing the draft does not automatically trigger a rebuild.
57
57
</Aside>
58
58
59
59
9. When ready:
@@ -64,10 +64,7 @@ To release a new version of Terragrunt:
64
64
65
65
### Retrying a Failed Build
66
66
67
-
If the build workflow fails mid-way:
68
-
69
-
-**Edit the draft** (e.g., point it at a new commit) to re-trigger the workflow. Assets are automatically overwritten.
70
-
- Alternatively, use the **workflow_dispatch** trigger on the Release workflow, providing the version string (e.g., `v1.0.2`). This looks up the existing draft release and rebuilds.
67
+
If the build workflow fails mid-way, re-run the Release workflow via **workflow_dispatch** with the same version (e.g., `v1.0.2`). It looks up the existing draft release and rebuilds, overwriting any previously uploaded assets.
0 commit comments