From c478ab603b1b16520907d1b719c2a41e7fc5311d Mon Sep 17 00:00:00 2001 From: Erin Young Date: Fri, 27 Dec 2024 17:50:27 +0000 Subject: [PATCH 1/3] added build-files subdirectory --- .github/PULL_REQUEST_TEMPLATE.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7014bd7d1..7e87ebf40 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -16,10 +16,10 @@ Please replace all '[ ]' with '[X]' to demonstrate completion. Pull Request (PR) checklist: - [ ] Include a description of what is in this pull request in this message. -- [ ] The dockerfile successfully builds to a test target for the user creating the PR. (i.e. `docker build --tag samtools:1.15test --target test docker-builds/samtools/1.15` ) -- [ ] Directory structure as name of the tool in lower case with special characters removed with a subdirectory of the version number (i.e. `spades/3.12.0/Dockerfile`) - - [ ] (optional) All test files are located in same directory as the Dockerfile (i.e. `shigatyper/2.0.1/test.sh`) -- [ ] Create a simple container-specific [README.md](https://github.com/StaPH-B/docker-builds/blob/master/.github/workflow-templates/readme-template.md) in the same directory as the Dockerfile (i.e. `spades/3.12.0/README.md`) +- [ ] The dockerfile successfully builds to a test target for the user creating the PR. (i.e. `docker build --tag samtools:1.15test --target test build-files/samtools/1.15` ) +- [ ] Directory structure as name of the tool in lower case with special characters removed with a subdirectory of the version number in build-files (i.e. `build-files/spades/3.12.0/Dockerfile`) + - [ ] (optional) All test files are located in same directory as the Dockerfile (i.e. `build-files/shigatyper/2.0.1/test.sh`) +- [ ] Create a simple container-specific [README.md](https://github.com/StaPH-B/docker-builds/blob/master/.github/workflow-templates/readme-template.md) in the same directory as the Dockerfile (i.e. `build-files/spades/3.12.0/README.md`) - [ ] If this README is longer than 30 lines, there is an explanation as to why more detail was needed - [ ] Dockerfile includes the recommended [LABELS](https://github.com/StaPH-B/docker-builds/blob/master/dockerfile-template/Dockerfile#L8-L18) - [ ] Main [README.md](https://github.com/StaPH-B/docker-builds/blob/master/README.md) has been updated to include the tool and/or version of the dockerfile(s) in this PR From d194e0c65a7e9960c98459f0c1d9bbaf531dff80 Mon Sep 17 00:00:00 2001 From: Erin Young Date: Fri, 27 Dec 2024 17:52:16 +0000 Subject: [PATCH 2/3] added build-files subdirectory --- .github/workflows/manual-deploy.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/manual-deploy.yml b/.github/workflows/manual-deploy.yml index 2cd7c250a..ee2bf6d7a 100644 --- a/.github/workflows/manual-deploy.yml +++ b/.github/workflows/manual-deploy.yml @@ -10,16 +10,16 @@ on: workflow_dispatch: inputs: tool: - description: "Tool to deploy. Must match filepath: //version/Dockerfile" + description: "Tool to deploy. Must match filepath: build-files//version/Dockerfile" required: true version: - description: "Version to deploy. Must match filepath: /tool//Dockerfile" + description: "Version to deploy. Must match filepath: build-files/tool//Dockerfile" required: true docker_image_tag: description: "Docker image tag to use: repository/tool: (Match version unless you require a custom tag)" required: true push_quay: - description: "Deploy to Quay too? (repository must first exist on quay)" + description: "Deploy to Quay too?" type: boolean default: true push_latest_tag: @@ -38,7 +38,7 @@ jobs: build-to-test: uses: ./.github/workflows/build-to-test.yml with: - path_to_context: "./${{ github.event.inputs.tool }}/${{ github.event.inputs.version }}" + path_to_context: "./build-files/${{ github.event.inputs.tool }}/${{ github.event.inputs.version }}" cache: ${{ github.event.inputs.tool }} # This job calls a workflow to build the image to the 'app' stage and pushes the image to Docker Hub @@ -51,7 +51,7 @@ jobs: quay_username: ${{ secrets.quay_username }} quay_robot_token: ${{ secrets.quay_robot_token }} with: - path_to_context: "./${{ github.event.inputs.tool }}/${{ github.event.inputs.version }}" + path_to_context: "./build-files/${{ github.event.inputs.tool }}/${{ github.event.inputs.version }}" repository_name: ${{ github.event.inputs.repository_name }} cache: ${{ github.event.inputs.tool }} container_name: ${{ github.event.inputs.tool }} From 10da454f5137b82ceba50fd95d2ebe32168195dc Mon Sep 17 00:00:00 2001 From: Young Date: Fri, 27 Dec 2024 10:58:02 -0700 Subject: [PATCH 3/3] Added full path --- .github/PULL_REQUEST_TEMPLATE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7e87ebf40..707715b45 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -16,10 +16,10 @@ Please replace all '[ ]' with '[X]' to demonstrate completion. Pull Request (PR) checklist: - [ ] Include a description of what is in this pull request in this message. -- [ ] The dockerfile successfully builds to a test target for the user creating the PR. (i.e. `docker build --tag samtools:1.15test --target test build-files/samtools/1.15` ) -- [ ] Directory structure as name of the tool in lower case with special characters removed with a subdirectory of the version number in build-files (i.e. `build-files/spades/3.12.0/Dockerfile`) +- [ ] The dockerfile successfully builds to a test target for the user creating the PR. (i.e. `docker build --tag samtools:1.15test --target test docker-builds/build-files/samtools/1.15` ) +- [ ] Directory structure as name of the tool in lower case with special characters removed with a subdirectory of the version number in build-files (i.e. `docker-builds/build-files/spades/3.12.0/Dockerfile`) - [ ] (optional) All test files are located in same directory as the Dockerfile (i.e. `build-files/shigatyper/2.0.1/test.sh`) -- [ ] Create a simple container-specific [README.md](https://github.com/StaPH-B/docker-builds/blob/master/.github/workflow-templates/readme-template.md) in the same directory as the Dockerfile (i.e. `build-files/spades/3.12.0/README.md`) +- [ ] Create a simple container-specific [README.md](https://github.com/StaPH-B/docker-builds/blob/master/.github/workflow-templates/readme-template.md) in the same directory as the Dockerfile (i.e. `docker-builds/build-files/spades/3.12.0/README.md`) - [ ] If this README is longer than 30 lines, there is an explanation as to why more detail was needed - [ ] Dockerfile includes the recommended [LABELS](https://github.com/StaPH-B/docker-builds/blob/master/dockerfile-template/Dockerfile#L8-L18) - [ ] Main [README.md](https://github.com/StaPH-B/docker-builds/blob/master/README.md) has been updated to include the tool and/or version of the dockerfile(s) in this PR