Skip to content

Commit 311cd03

Browse files
fabianvfjmrodri
andauthored
Run generate before prerelease (#4952)
* Run generate before prerelease Signed-off-by: Fabian von Feilitzsch <[email protected]> * Update website/content/en/docs/contribution-guidelines/releasing.md Co-authored-by: Jesus Rodriguez <[email protected]> Signed-off-by: Fabian von Feilitzsch <[email protected]> Co-authored-by: Jesus Rodriguez <[email protected]>
1 parent 5e64de8 commit 311cd03

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ release: ## Release target. See 'make -f release/Makefile help' for more informa
110110
$(MAKE) -f release/Makefile $@
111111

112112
.PHONY: prerelease
113-
prerelease: ## Write release commit changes. See 'make -f release/Makefile help' for more information.
113+
prerelease: generate ## Write release commit changes. See 'make -f release/Makefile help' for more information.
114114
ifneq ($(RELEASE_VERSION),$(IMAGE_VERSION))
115115
$(error "IMAGE_VERSION "$(IMAGE_VERSION)" must be updated to match RELEASE_VERSION "$(RELEASE_VERSION)" prior to creating a release commit")
116116
endif

website/content/en/docs/contribution-guidelines/releasing.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -101,15 +101,17 @@ make prerelease
101101

102102
The following changes should be present:
103103

104+
- `Makefile`: IMAGE_VERSION should be modified to the upcoming release tag. (This variable ensures sampleprojects have been tagged correctly prior to the release commit.)
104105
- `changelog/generated/v1.3.0.md`: commit changes (created by changelog generation).
105106
- `changelog/fragments/*`: commit deleted fragment files (deleted by changelog generation).
106107
- `website/content/en/docs/upgrading-sdk-version/v1.3.0.md`: commit changes (created by changelog generation).
107108
- `website/config.toml`: commit changes (modified by release script).
109+
- `testdata/*`: Generated sample code.
108110

109111
Commit these changes and push to your remote (assuming your remote is named `origin`):
110112

111113
```sh
112-
git add --all
114+
git add Makefile changelog website testdata
113115
git commit -m "Release $RELEASE_VERSION"
114116
git push -u origin release-$RELEASE_VERSION
115117
```
@@ -210,9 +212,6 @@ following commands from the root of the project.
210212
sed -i -E 's/(IMAGE_VERSION = ).+/\1v1\.3\.1/g' Makefile
211213
# Run the pre-release `make` target:
212214
make prerelease
213-
# Regenerate testdata (samples).
214-
# NOTE: The sanity test will fail but scaffolding should complete.
215-
make test-sanity
216215
```
217216

218217
All of the following changes should be present (and no others).
@@ -225,7 +224,7 @@ All of the following changes should be present (and no others).
225224
Commit these changes and push these changes **to your fork**:
226225

227226
```sh
228-
git add --all
227+
git add Makefile changelog website testdata
229228
git commit -sm "Release $RELEASE_VERSION"
230229
git push -u origin release-$RELEASE_VERSION
231230
```

0 commit comments

Comments
 (0)