From ac911e740ce2f165234fa59ea2edbbd3fa05375d Mon Sep 17 00:00:00 2001 From: Fabian von Feilitzsch Date: Thu, 27 May 2021 13:02:31 -0400 Subject: [PATCH 1/2] Run generate before prerelease Signed-off-by: Fabian von Feilitzsch --- Makefile | 2 +- .../content/en/docs/contribution-guidelines/releasing.md | 9 ++++----- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/Makefile b/Makefile index aab75c30969..16317a5a085 100644 --- a/Makefile +++ b/Makefile @@ -100,7 +100,7 @@ release: ## Release target. See 'make -f release/Makefile help' for more informa $(MAKE) -f release/Makefile $@ .PHONY: prerelease -prerelease: ## Write release commit changes. See 'make -f release/Makefile help' for more information. +prerelease: generate ## Write release commit changes. See 'make -f release/Makefile help' for more information. ifneq ($(RELEASE_VERSION),$(IMAGE_VERSION)) $(error "IMAGE_VERSION "$(IMAGE_VERSION)" must be updated to match RELEASE_VERSION "$(RELEASE_VERSION)" prior to creating a release commit") endif diff --git a/website/content/en/docs/contribution-guidelines/releasing.md b/website/content/en/docs/contribution-guidelines/releasing.md index de7d4e5063c..a84876d95bf 100644 --- a/website/content/en/docs/contribution-guidelines/releasing.md +++ b/website/content/en/docs/contribution-guidelines/releasing.md @@ -76,15 +76,17 @@ make prerelease The following changes should be present: +- `Makefile`: IMAGE_VERSION should be modified to the upcoming release tag. (This variable ensures sampleprojects have been tagged correctpy prior to the release commit.) - `changelog/generated/v1.3.0.md`: commit changes (created by changelog generation). - `changelog/fragments/*`: commit deleted fragment files (deleted by changelog generation). - `website/content/en/docs/upgrading-sdk-version/v1.3.0.md`: commit changes (created by changelog generation). - `website/config.toml`: commit changes (modified by release script). +- `testdata/*`: Generated sample code. Commit these changes and push to your remote (assuming your remote is named `origin`): ```sh -git add --all +git add Makefile changelog website testdata git commit -m "Release $RELEASE_VERSION" git push -u origin release-$RELEASE_VERSION ``` @@ -171,9 +173,6 @@ following commands from the root of the project. sed -i -E 's/(IMAGE_VERSION = ).+/\1v1\.3\.1/g' Makefile # Run the pre-release `make` target: make prerelease -# Regenerate testdata (samples). -# NOTE: The sanity test will fail but scaffolding should complete. -make test-sanity ``` All of the following changes should be present (and no others). @@ -186,7 +185,7 @@ All of the following changes should be present (and no others). Commit these changes and push these changes **to your fork**: ```sh -git add --all +git add Makefile changelog website testdata git commit -sm "Release $RELEASE_VERSION" git push -u origin release-$RELEASE_VERSION ``` From 86a008afd7e8c5aa6088672891397aa0fe5ce023 Mon Sep 17 00:00:00 2001 From: Fabian von Feilitzsch Date: Fri, 3 Sep 2021 16:48:07 -0400 Subject: [PATCH 2/2] Update website/content/en/docs/contribution-guidelines/releasing.md Co-authored-by: Jesus Rodriguez Signed-off-by: Fabian von Feilitzsch --- website/content/en/docs/contribution-guidelines/releasing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/en/docs/contribution-guidelines/releasing.md b/website/content/en/docs/contribution-guidelines/releasing.md index a84876d95bf..43a4ca27721 100644 --- a/website/content/en/docs/contribution-guidelines/releasing.md +++ b/website/content/en/docs/contribution-guidelines/releasing.md @@ -76,7 +76,7 @@ make prerelease The following changes should be present: -- `Makefile`: IMAGE_VERSION should be modified to the upcoming release tag. (This variable ensures sampleprojects have been tagged correctpy prior to the release commit.) +- `Makefile`: IMAGE_VERSION should be modified to the upcoming release tag. (This variable ensures sampleprojects have been tagged correctly prior to the release commit.) - `changelog/generated/v1.3.0.md`: commit changes (created by changelog generation). - `changelog/fragments/*`: commit deleted fragment files (deleted by changelog generation). - `website/content/en/docs/upgrading-sdk-version/v1.3.0.md`: commit changes (created by changelog generation).