Skip to content

Commit 3220ce9

Browse files
sbkoksbkok
committed
Install: Add version checks and pre-deploy warnings (awslabs#726)
**Why?** When you clone the ADF Github repository, it will not fetch the git tags. The installation docs describe that you should run `git fetch --tags` to retrieve those. However, if someone forgets to run that command, you run into a weird error that does not describe what is going wrong in a resolvable manner: > Error: Failed to create changeset for the stack: aws-deployment-framework, > Parameter validation failed: > Invalid length for parameter Tags[0].Value, value: 0, valid min length: 1 Additionally, if you installed ADF with the updated installer before. Then forget to fetch the latest git tags when you are about to deploy a new version of ADF, it will return a version number that is based on the old version instead of the new one. Making it hard to determine what version of ADF was installed. Long story short, the version in the `src/template.yml` should never be newer than the version determined via git tags. **What?** Added check to verify that the version number can be determined correctly. * If it did not return the version number, but an empty string instead: * it will test whether there is a .git folder. * If not, the user should clone a repository instead. * If the .git directory exists, it will instruct the user to fetch the git tags. * If a version number is returned, it will check whether the version number matches with the tag. * If it does, this means that it is building a released version of ADF. * If it does not, the user might not have switched to the right version tag yet. Hence, we warn the user to proceed with caution. Additionally, this change will add a warning when ADF gets deployed that the specific version and changes should be reviewed and tested in a non-production environment. Lastly, a check is added to ensure that the ADF version of the `src/template.yml` file should not be newer than the version resolved via git tags. If this is the case, it should instruct the user to fetch the latest tags from the ADF repository.
1 parent 5e5dc61 commit 3220ce9

2 files changed

Lines changed: 108 additions & 12 deletions

File tree

‎.github/workflows/adf.yml‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ name: ADF CI
22

33
on: [push, pull_request]
44

5+
env:
6+
CI_BUILD: 1
7+
58
jobs:
69
build:
710
runs-on: ubuntu-latest
@@ -11,7 +14,10 @@ jobs:
1114

1215
steps:
1316
- name: Checkout Repo
14-
uses: actions/checkout@v3
17+
uses: actions/checkout@v4
18+
with:
19+
fetch-depth: 150
20+
fetch-tags: true
1521
- name: Set up Python ${{ matrix.python-version }}
1622
uses: actions/setup-python@v4
1723
with:

‎Makefile‎

Lines changed: 101 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
# SPDX-License-Identifier: Apache-2.0
33

44
# Makefile versions
5-
MAKEFILE_VERSION := 2.1
5+
MAKEFILE_VERSION := 2.2
66
UPDATE_VERSION := make/latest
77

88
# This Makefile requires Python version 3.9 or later
99
REQUIRED_PYTHON_MAJOR_VERSION := 3
1010
REQUIRED_PYTHON_MINOR_VERSION := 9
11-
PYTHON_EXECUTABLE := "python$(REQUIRED_PYTHON_MAJOR_VERSION)"
11+
PYTHON_EXECUTABLE := python$(REQUIRED_PYTHON_MAJOR_VERSION)
1212

1313
# Repository versions
1414
SRC_VERSION := $(shell git describe --tags --match 'v[0-9]*')
@@ -18,9 +18,13 @@ SRC_VERSION_TAG_ONLY := $(shell git describe --tags --abbrev=0 --match 'v[0-9]*'
1818
SRC_URL_BASE := https://github.com/awslabs/aws-deployment-framework
1919
RAW_URL_BASE := https://raw.githubusercontent.com/awslabs/aws-deployment-framework
2020

21-
UPDATE_URL := "$(RAW_URL_BASE)/$(UPDATE_VERSION)/Makefile"
22-
SRC_TAGGED_URL_BASE := "$(SRC_URL_BASE)/tree/$(SRC_VERSION_TAG_ONLY)"
23-
MAKE_TAGGED_URL_BASE := "$(SRC_URL_BASE)/tree/make/$(MAKEFILE_VERSION)"
21+
UPDATE_URL := $(RAW_URL_BASE)/$(UPDATE_VERSION)/Makefile
22+
SRC_TAGGED_URL_BASE := $(SRC_URL_BASE)/tree/$(SRC_VERSION_TAG_ONLY)
23+
MAKE_TAGGED_URL_BASE := $(SRC_URL_BASE)/tree/make/$(MAKEFILE_VERSION)
24+
SRC_TAGGED_INSTALLATION_DOCS_URL := $(SRC_TAGGED_URL_BASE)/docs/installation-guide.md
25+
MAKE_TAGGED_INSTALLATION_DOCS_URL := $(MAKE_TAGGED_URL_BASE)/docs/installation-guide.md
26+
ISSUES_URL := $(SRC_URL_BASE)/issues
27+
RELEASE_NOTES_URL := $(SRC_URL_BASE)/releases/tag/$(SRC_VERSION_TAG_ONLY)
2428

2529
# Command line colors
2630
CLR_RED := $(shell printf "\033[0;31m")
@@ -47,7 +51,8 @@ all: build
4751
# Which actions do not create an actual file like make expects:
4852
.PHONY: all clean update_makefile
4953
.PHONY: report_makefile_version report_versions version_report
50-
.PHONY: build_debs deps src_deps docker version_number git_ignore docs tox
54+
.PHONY: build_debs deps src_deps tox docker version_number git_ignore docs
55+
.PHONY: verify_rooling verify_version
5156
.PHONY: pre_build pre_deps_build sam_build post_build build deps_build
5257
.PHONY: pre_deploy_msg pre_deploy sam_deploy post_deploy deploy
5358

@@ -171,8 +176,8 @@ docs:
171176
@echo ""
172177
@( \
173178
echo "$(SRC_VERSION_TAG_ONLY)" | grep -E 'v[0-3]\.' &> /dev/null && \
174-
echo "* $(CLR_BLUE)$(MAKE_TAGGED_URL_BASE)/docs/installation-guide.md$(CLR_END)" || \
175-
echo "* $(CLR_BLUE)$(SRC_TAGGED_URL_BASE)/docs/installation-guide.md$(CLR_END)"; \
179+
echo "* $(CLR_BLUE)$(MAKE_TAGGED_INSTALLATION_DOCS_URL)$(CLR_END)" || \
180+
echo "* $(CLR_BLUE)$(SRC_TAGGED_INSTALLATION_DOCS_URL)$(CLR_END)"; \
176181
)
177182
@echo ""
178183
@echo "* $(CLR_BLUE)$(SRC_TAGGED_URL_BASE)/docs/admin-guide.md$(CLR_END)"
@@ -222,7 +227,74 @@ verify_tooling: .venv
222227
); \
223228
)
224229

225-
pre_build: build_deps docker version_number git_ignore
230+
verify_version: .venv
231+
@# If the version is empty and we are not in a CI build
232+
@( \
233+
if [ "Z${SRC_VERSION}" = "Z" ] && [ "Z$${CI_BUILD}" = "Z" ]; then \
234+
echo '' && \
235+
echo '$(CLR_RED)Error: Unable to determine the ADF version!$(CLR_END)' && \
236+
if [ -e .git ]; then \
237+
echo '$(CLR_RED)The current directory is not a git clone of ADF.$(CLR_END)' && \
238+
echo '' && \
239+
echo '$(CLR_RED)Please read the installation guide to resolve this error:$(CLR_END)' && \
240+
echo '* $(CLR_BLUE)$(MAKE_TAGGED_INSTALLATION_DOCS_URL)$(CLR_END)' && \
241+
exit 1; \
242+
fi && \
243+
echo '$(CLR_RED)Most likely, the git tags have not been fetched yet.$(CLR_END)' && \
244+
echo '' && \
245+
echo '$(CLR_RED)Please fetch the git tags from the cloned repository to continue.$(CLR_END)' && \
246+
echo '$(CLR_RED)You can do this by running:$(CLR_END) git fetch --tags origin' && \
247+
echo '' && \
248+
exit 1; \
249+
fi \
250+
)
251+
@# If the src/template.yml version is newer than the git tagged version and
252+
@# we are not in a CI build
253+
@( \
254+
. .venv/bin/activate; \
255+
BASE_ADF_VERSION=$$(cat $(SRC_DIR)/template.yml | yq '.Metadata."AWS::ServerlessRepo::Application".SemanticVersion' -r); \
256+
[ "Z$${CI_BUILD}" != "Z" ] || \
257+
$(PYTHON_EXECUTABLE) -c "import sys; from packaging import version; version.parse(\"$$BASE_ADF_VERSION\") > version.parse(\"$(SRC_VERSION_TAG_ONLY)\") and sys.exit(1)" || \
258+
( \
259+
echo '' && \
260+
echo '$(CLR_RED)Error: ADF Main template version is newer than the requested git tag version!$(CLR_END)' && \
261+
echo '$(CLR_RED)Most likely, the git tags have not been fetched recently yet.$(CLR_END)' && \
262+
echo '' && \
263+
echo '$(CLR_RED)Please fetch the git tags from the cloned repository to continue.$(CLR_END)' && \
264+
echo '$(CLR_RED)You can do this by running:$(CLR_END) git fetch --tags origin' && \
265+
echo '' && \
266+
echo "$(CLR_RED)ADF Main template version (src/template.yml):$(CLR_END) v$$BASE_ADF_VERSION" && \
267+
echo '$(CLR_RED)Resolved ADF version using git tags:$(CLR_END) $(SRC_VERSION_TAG_ONLY)' && \
268+
echo '' && \
269+
exit 1 \
270+
) \
271+
)
272+
@# If the version number is not a release-tagged version and we are not in a CI build
273+
@( \
274+
if [ "Z$(SRC_VERSION)" != "Z$(SRC_VERSION_TAG_ONLY)" ] && [ "Z$${CI_BUILD}" = "Z" ]; then \
275+
echo '' && \
276+
echo '$(CLR_RED)Caution: You are about to build the AWS Deployment Framework (ADF)$(CLR_END)' && \
277+
echo '$(CLR_RED)with commits that have not undergone the standard release testing process.$(CLR_END)' && \
278+
echo '' && \
279+
echo '$(CLR_RED)These untested commits may potentially cause issues or disruptions to your$(CLR_END)' && \
280+
echo '$(CLR_RED)existing ADF installation and deployment pipelines.$(CLR_END)' && \
281+
echo '$(CLR_RED)Please proceed with extreme caution and ensure you have appropriate backups$(CLR_END)' && \
282+
echo '$(CLR_RED)and contingency plans in place. It is highly recommended to thoroughly review$(CLR_END)' && \
283+
echo '$(CLR_RED)and test these commits in a non-production environment before you proceed.$(CLR_END)' && \
284+
echo '' && \
285+
echo 'ADF version base tag: $(CLR_RED)$(SRC_VERSION_TAG_ONLY)$(CLR_END)' && \
286+
echo 'ADF version of current commit: $(CLR_RED)$(SRC_VERSION)$(CLR_END)' && \
287+
echo '' && \
288+
echo 'Are you sure you want to continue? [y/N] ' && \
289+
read answer && \
290+
if [ "$${answer:-'N'}" != "Y" ] && [ "$${answer:-'N'}" != "y" ]; then \
291+
echo 'Aborting...' && \
292+
exit 1; \
293+
fi \
294+
fi \
295+
)
296+
297+
pre_build: build_deps docker version_number verify_version git_ignore
226298

227299
pre_deps_build: deps docker version_number git_ignore
228300

@@ -250,13 +322,31 @@ pre_deploy_msg:
250322
@echo ""
251323
@echo "$(CLR_GREEN)Thank you for deploying ADF, we are about to proceed$(CLR_END)"
252324
@echo ""
325+
@echo "$(CLR_RED)Caution:$(CLR_END) You are about to deploy ADF $(SRC_VERSION)."
326+
@echo "Proceeding with the deployment will directly impact an existing ADF"
327+
@echo "installation and ADF pipelines in this AWS Organization."
328+
@echo "It is highly recommended to thoroughly review and test this version"
329+
@echo "of ADF in a non-production environment before you proceed."
330+
@echo ""
331+
@echo "It is important to check the release notes prior to installing or updating."
332+
@( \
333+
if [ "Z$(SRC_VERSION)" != "Z$(SRC_VERSION_TAG_ONLY)" ]; then \
334+
echo "Please read the local CHANGELOG.md file in the root of the repository."; \
335+
else \
336+
echo "Release notes of $(SRC_VERSION_TAG_ONLY) can be found at: $(CLR_BLUE)$(RELEASE_NOTES_URL)$(CLR_END)"; \
337+
fi \
338+
)
339+
@echo ""
340+
@echo "Please also check whether there are known issues at: $(CLR_BLUE)$(ISSUES_URL)$(CLR_END)"
341+
@echo "If you run into an issue, you can report these via GitHub issues."
342+
@echo ""
253343
@echo "$(CLR_YELLOW)In the next step, a few questions need to be answered.$(CLR_END)"
254344
@echo "$(CLR_YELLOW)Please use the following guide to answer these:$(CLR_END)"
255345
@echo ""
256346
@( \
257347
echo "$(SRC_VERSION_TAG_ONLY)" | grep -E 'v[0-3]\.' &> /dev/null && \
258-
echo "$(CLR_BLUE)$(MAKE_TAGGED_URL_BASE)/docs/installation-guide.md$(CLR_END)" || \
259-
echo "$(CLR_BLUE)$(SRC_TAGGED_URL_BASE)/docs/installation-guide.md$(CLR_END)"; \
348+
echo "$(CLR_BLUE)$(MAKE_TAGGED_INSTALLATION_DOCS_URL)$(CLR_END)" || \
349+
echo "$(CLR_BLUE)$(SRC_TAGGED_INSTALLATION_DOCS_URL)$(CLR_END)"; \
260350
)
261351
@echo ""
262352
@echo ""

0 commit comments

Comments
 (0)