Skip to content
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

Quick: Update Makefile to support git branches #801

Merged
merged 4 commits into from
Feb 9, 2024
Merged

Quick: Update Makefile to support git branches #801

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4d066c5
update Makefile to support git branches
rstijerina Feb 8, 2024
187b528
fix comment
rstijerina Feb 8, 2024
783b7fb
rearrange vars
rstijerina Feb 9, 2024
862e5f5
Merge branch 'main' into quick/update-makefile-support-branch-tags
wesleyboar Feb 9, 2024
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
7 changes: 7 additions & 0 deletions Makefile
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

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

@rstijerina, I must wait until the end of the build (which can be long) before I see docker tag output.1

How could I see that output sooner? So I could copy-paste to Core-Portal-Deployments during build.

+	echo "Building '`$(DOCKER_IMAGE_BRANCH)`'…"
	docker build -t $(DOCKER_IMAGE) \
-	docker build -t $(DOCKER_IMAGE) \
+	docker build -t $(DOCKER_IMAGE_BRANCH) \

Footnotes

  1. docker tag taccwma/core-cms:783b7fb taccwma/core-cms:test-update-makefile-support-branch-tags ↩

Copy link
Member Author

Choose a reason for hiding this comment

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

@wesleyboar Good suggestion. We could add DOCKER_IMAGE_BRANCH=... and echo "Building '$(DOCKER_IMAGE_BRANCH)'…" to the Jenkins build as well

Copy link
Member

Choose a reason for hiding this comment

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

I dunno about putting same script snippet in Makefile and Jenkins. If after using this a while, I feel the urge, then I'll think on a shared code solution or give in to copy-paste.

Copy link
Collaborator

@taoteg taoteg Feb 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

In the jenkins build console output, you can see what the tag is going to be at the very top (before STEP 1 begins) in these lines (copied from your build job above - https://jenkins01.tacc.utexas.edu/job/Core_CMS_Build/1375/console):

Previous HEAD position was cadaf60... chore: v4.7.2 (#800)
HEAD is now at 783b7fb... rearrange vars

then a few lines later:

docker build -t taccwma/core-cms:783b7fb \
	--target production \
	--build-arg PROJECT_NAME="" \
	--build-arg BUILD_ID="v4.6.0-18-g783b7fb" \
	--build-arg NEEDS_DEMO="true" \
	-f ./Dockerfile .

which is the same things you will see in STEP 25:

Building "Core" styles:
Tagging CSS version as @tacc/core-cms v4.6.0-18-g783b7fb | MIT | github.com/TACC/Core-CMS

and reflects what you get at the end of the build pipe if it is successful:

Step 28/28 : COPY --from=node_build /code/ /code
 ---> 2bbb8033c87f
Successfully built 2bbb8033c87f
Successfully tagged taccwma/core-cms:783b7fb

Does that help?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think this doesn't include the special char replacement done by the DOCKER_IMAGE_BRANCH var

Copy link
Collaborator

@taoteg taoteg Feb 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Looks like this (in the beginning):

Fetching origin
+ git checkout test-update-makefile-support-branch-tags
Previous HEAD position was cadaf60... chore: v4.7.2 (#800)
HEAD is now at 783b7fb... rearrange vars
+ git describe --exact-match --tags HEAD
test-update-makefile-support-branch-tags

still matches this output (at the very end):

docker push taccwma/core-cms:test-update-makefile-support-branch-tags
The push refers to repository [docker.io/taccwma/core-cms]
...
test-update-makefile-support-branch-tags: digest: sha256:6f28e24b0d468bd71a8d5fb4da2beb0bdc19e0620c1c07992c8b8a91ed4ca52c size: 3691
+ '[' test-update-makefile-support-branch-tags == main ']'

Is that because Wes names things well and therefore there was no real conversion of special characters from the value in the .env file (CMS_TAG=test-update-makefile-support-branch-tags # v4.8.0 candidate)?

Copy link
Member Author

Choose a reason for hiding this comment

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

But if the branch was test/update-makefile-support-branch-tags, that would not match with it being converted to test-update-makefile-support-branch-tags by the DOCKER_IMAGE_BRANCH var

Is that because Wes names things well and therefore there was no real conversion of special characters from the value

yeah, exactly

Copy link
Member

@wesleyboar wesleyboar Feb 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

@taoteg was right to look at other lines. What I want (most of the time) is available reliably enough via:

+ git describe --exact-match --tags HEAD
v4.8.0

Not a branch name, but it matches when I build via tag.

When I next need to build by branch, I [may return to] this.

Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ PROJECT_NAME := $(shell cat ./project_name.var)
NEEDS_DEMO := $(shell cat ./needs_demo.var)
BUILD_ID := $(shell git describe --always)

# NOTE: The `DOCKER_IMAGE_BRANCH` tag is the git tag for the commit if it exists, else the branch on which the commit exists.
# NOTE: Special characters in `DOCKER_IMAGE_BRANCH` are replaced with dashes.
DOCKER_IMAGE_BRANCH := $(DOCKERHUB_REPO):$(shell git describe --exact-match --tags 2> /dev/null || git symbolic-ref --short HEAD | sed 's/[^[:alnum:]\.\_\-]/-/g')

.PHONY: build
build:
docker-compose -f ./docker-compose.yml build
Expand All @@ -20,13 +24,16 @@ build-full:
--build-arg NEEDS_DEMO="$(NEEDS_DEMO)" \
-f ./Dockerfile .

docker tag $(DOCKER_IMAGE) $(DOCKER_IMAGE_BRANCH)

.PHONY: example
example:
docker-compose -f ./docker-compose.example.yml up

.PHONY: publish
publish:
docker push $(DOCKER_IMAGE)
docker push $(DOCKER_IMAGE_BRANCH)

.PHONY: publish-latest
publish-latest:
Expand Down