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

ci: push devcontainer on workflow dispatch #2485

Closed
wants to merge 4 commits into from
Closed

ci: push devcontainer on workflow dispatch #2485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1d4ed0f
ci: push devcontainer on workflow dispatch
glihm Sep 30, 2024
aa83627
ci: confuse usage of docker tag to clean
glihm Sep 30, 2024
71cba6d
ci: adjust dojo version to be used for dojoup
glihm Sep 30, 2024
e2544f9
ci: fix typo
glihm Sep 30, 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
3 changes: 3 additions & 0 deletions .devcontainer/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,9 @@ RUN if [ "$BUILD_TYPE" = "release" ]; then \
elif [ "$BUILD_TYPE" = "push" ]; then \
echo "Installing Dojo at commit $DOJO_VERSION"; \
dojoup -c $DOJO_VERSION; \
elif [ "$BUILD_TYPE" = "workflow_dispatch" ]; then \
echo "Installing Dojo at commit $DOJO_VERSION"; \
dojoup -c $DOJO_VERSION; \
Comment on lines +79 to +81
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Ohayo, sensei! Avoid code duplication by consolidating conditions

The blocks for push and workflow_dispatch are performing the same actions. Consider combining them to simplify the script and reduce redundancy.

Apply this diff to refactor the code:

 RUN if [ "$BUILD_TYPE" = "release" ]; then \
     echo "Installing Dojo version $DOJO_VERSION"; \
     dojoup -v $DOJO_VERSION; \
-elif [ "$BUILD_TYPE" = "push" ]; then \
+elif [ "$BUILD_TYPE" = "push" ] || [ "$BUILD_TYPE" = "workflow_dispatch" ]; then \
     echo "Installing Dojo at commit $DOJO_VERSION"; \
     dojoup -c $DOJO_VERSION; \
-elif [ "$BUILD_TYPE" = "workflow_dispatch" ]; then \
-    echo "Installing Dojo at commit $DOJO_VERSION"; \
-    dojoup -c $DOJO_VERSION; \
 else \
     echo "Installing latest stable version of Dojo"; \
     dojoup; \
     fi
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
elif [ "$BUILD_TYPE" = "workflow_dispatch" ]; then \
echo "Installing Dojo at commit $DOJO_VERSION"; \
dojoup -c $DOJO_VERSION; \
elif [ "$BUILD_TYPE" = "push" ] || [ "$BUILD_TYPE" = "workflow_dispatch" ]; then \
echo "Installing Dojo at commit $DOJO_VERSION"; \
dojoup -c $DOJO_VERSION; \

else \
echo "Installing latest stable version of Dojo"; \
dojoup; \
Expand Down
8 changes: 6 additions & 2 deletions .github/workflows/devcontainer.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,17 +43,21 @@ jobs:
if: github.event_name == 'release'
run: |
echo "DOCKER_TAG=${{ github.event.release.tag_name }}" >> $GITHUB_ENV
echo "DOJO_VERSION=${{ github.event.release.tag_name }}" >> $GITHUB_ENV
echo "tag_name=$DOCKER_TAG" >> $GITHUB_OUTPUT

- name: Set Docker tag for push event
if: github.event_name == 'push'
run: |
SHORT_SHA=$(echo "${{ github.sha }}" | cut -c 1-7)
echo "DOCKER_TAG=$SHORT_SHA" >> $GITHUB_ENV
echo "DOJO_VERSION=$SHORT_SHA" >> $GITHUB_ENV

- name: Set Docker tag for workflow_dispatch event
if: github.event_name == 'workflow_dispatch'
run: |
SHORT_SHA=$(echo "${{ github.sha }}" | cut -c 1-7)
echo "DOJO_VERSION=$SHORT_SHA" >> $GITHUB_ENV
Comment on lines +59 to +60
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Ohayo, sensei! Let's clarify the version setting for workflow_dispatch.

The addition of SHORT_SHA and DOJO_VERSION for the workflow_dispatch event is good, but there's a potential inconsistency:

  1. DOJO_VERSION is set to the short SHA, while DOCKER_TAG uses the user input.
  2. We might want to use double quotes to prevent issues with special characters.

Consider the following changes:

- SHORT_SHA=$(echo "${{ github.sha }}" | cut -c 1-7)
- echo "DOJO_VERSION=$SHORT_SHA" >> $GITHUB_ENV
+ SHORT_SHA=$(echo "${{ github.sha }}" | cut -c 1-7)
+ echo "DOJO_VERSION=\"${{ inputs.docker_tag }}\"" >> $GITHUB_ENV

This aligns DOJO_VERSION with DOCKER_TAG for consistency. However, if there's a specific reason for using the short SHA instead of the user input for DOJO_VERSION, please clarify.

Committable suggestion was skipped due to low confidence.

echo "DOCKER_TAG=${{ inputs.docker_tag }}" >> $GITHUB_ENV

- name: Set outputs
Expand All @@ -64,13 +68,13 @@ jobs:
- name: Build and push Docker image
uses: docker/build-push-action@v2
with:
push: ${{ (github.event_name == 'push' && github.ref == 'refs/heads/main') || (github.event_name == 'release' && startsWith(github.ref, 'refs/tags/')) }}
push: ${{ (github.event_name == 'push' && github.ref == 'refs/heads/main') || (github.event_name == 'release' && startsWith(github.ref, 'refs/tags/')) || github.event_name == 'workflow_dispatch' }}
file: .devcontainer/Dockerfile
tags: ghcr.io/${{ github.repository }}-dev:latest,ghcr.io/${{ github.repository }}-dev:${{ env.DOCKER_TAG }}
build-args: |
VARIANT=bookworm
BUILD_TYPE=${{ github.event_name }}
DOJO_VERSION=${{ github.event.release.tag_name }}
DOJO_VERSION=${{ env.DOJO_VERSION }}
platforms: linux/amd64,linux/arm64
cache-from: type=registry,ref=ghcr.io/${{ github.repository }}-dev:latest

Expand Down
Loading