Skip to content

Commit

Permalink
Install: Add uncommitted changes check (awslabs#733)
Browse files Browse the repository at this point in the history
**Why?**

In case one were to checkout a tagged release, then make changes, ADF will
receive the tagged release number. Instead of tracking the change that was
made in the release number as well.

By preventing these uncommitted changes, it makes it easier to detect what
code is running in a specific version of ADF. So in case someone were to report
an issue we can assume the number indicates which version of the code failed.

**What?**

* Added check for uncommitted changes, these include files that are tracked
  by the git repository.
* Added check for newly created files, these would not be tracked by git yet.
  • Loading branch information
sbkok committed May 23, 2024
1 parent 3220ce9 commit d8005c0
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0

# Makefile versions
MAKEFILE_VERSION := 2.2
MAKEFILE_VERSION := 2.3
UPDATE_VERSION := make/latest

# This Makefile requires Python version 3.9 or later
Expand Down Expand Up @@ -269,6 +269,26 @@ verify_version: .venv
exit 1 \
) \
)
@# If there are uncommitted changes or new files, this implies that ADF
@# might be modified, hence we should track that in the version number
@( \
git diff-index --quiet HEAD -- src || ( \
echo '' && \
echo '$(CLR_RED)Error: There are uncommitted changes!$(CLR_END)' && \
echo '$(CLR_RED)Please commit these changes first to continue.$(CLR_END)' && \
echo '' && \
exit 1 \
); \
)
@( \
test -z "$$(git ls-files --others --exclude-standard -- src)" || ( \
echo '' && \
echo '$(CLR_RED)Error: New files were added to ADF its source code!$(CLR_END)' && \
echo '$(CLR_RED)Please commit these changes first to continue.$(CLR_END)' && \
echo '' && \
exit 1 \
); \
)
@# If the version number is not a release-tagged version and we are not in a CI build
@( \
if [ "Z$(SRC_VERSION)" != "Z$(SRC_VERSION_TAG_ONLY)" ] && [ "Z$${CI_BUILD}" = "Z" ]; then \
Expand Down

0 comments on commit d8005c0

Please sign in to comment.