Skip to content

Run generate before prerelease #4952

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 12, 2021
Merged

Run generate before prerelease #4952

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac911e7
Run generate before prerelease
fabianvf May 27, 2021
86a008a
Update website/content/en/docs/contribution-guidelines/releasing.md
fabianvf Sep 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 4 additions & 5 deletions website/content/en/docs/contribution-guidelines/releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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).
- `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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

git commit -m "Release $RELEASE_VERSION"
git push -u origin release-$RELEASE_VERSION
```
Expand Down Expand Up @@ -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).
Expand All @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

git commit -sm "Release $RELEASE_VERSION"
git push -u origin release-$RELEASE_VERSION
```
Expand Down