Skip to content

Commit cc5ad83

Browse files
danschmidt5189danschmidt5189
authored
Updates build/release workflows (#66)
Implements the new build/release workflows. RSpec and Rubocop reports are retained as build artifacts for the default retention period.
1 parent 7a45488 commit cc5ad83

7 files changed

Lines changed: 265 additions & 17 deletions

File tree

‎.dockerignore‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,9 @@ yarn-debug.log*
7676
# Ignore solr files
7777
solr/*/data/*
7878

79+
.ruby-lsp
80+
.cache
7981
.irb_history
80-
82+
.local
83+
.git
8184
.github

‎.github/workflows/build.yml‎

Lines changed: 196 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,196 @@
1+
name: Build / Test / Push
2+
3+
on:
4+
push:
5+
branches:
6+
- '**'
7+
workflow_dispatch:
8+
9+
env:
10+
BUILD_SUFFIX: -build-${{ github.run_id }}_${{ github.run_attempt }}
11+
DOCKER_METADATA_SET_OUTPUT_ENV: 'true'
12+
13+
jobs:
14+
build:
15+
runs-on: ${{ matrix.runner }}
16+
outputs:
17+
image-arm64: ${{ steps.gen-output.outputs.image-arm64 }}
18+
image-x64: ${{ steps.gen-output.outputs.image-x64 }}
19+
strategy:
20+
fail-fast: false
21+
matrix:
22+
runner:
23+
- ubuntu-24.04
24+
- ubuntu-24.04-arm
25+
steps:
26+
- name: Checkout code
27+
uses: actions/checkout@v4
28+
29+
- name: Set up Docker Buildx
30+
uses: docker/setup-buildx-action@v3
31+
32+
- name: Login to GitHub Container Registry
33+
uses: docker/login-action@v3
34+
with:
35+
registry: ghcr.io
36+
username: ${{ github.actor }}
37+
password: ${{ secrets.GITHUB_TOKEN }}
38+
39+
- id: build-meta
40+
name: Docker meta
41+
uses: docker/metadata-action@v5
42+
with:
43+
images: ghcr.io/${{ github.repository }}
44+
tags: type=sha,suffix=${{ env.BUILD_SUFFIX }}
45+
46+
# Build cache is shared among all builds of the same architecture
47+
- id: cache-meta
48+
name: Docker meta
49+
uses: docker/metadata-action@v5
50+
with:
51+
images: ghcr.io/${{ github.repository }}
52+
tags: type=raw,value=buildcache-${{ runner.arch }}
53+
54+
- id: get-registry
55+
name: Get the sanitized registry name
56+
run: |
57+
echo "registry=$(echo '${{ steps.build-meta.outputs.tags }}' | cut -f1 -d:)" | tee -a "$GITHUB_OUTPUT"
58+
59+
- id: build
60+
name: Build/push the arch-specific image
61+
uses: docker/build-push-action@v6
62+
with:
63+
cache-from: type=registry,ref=${{ steps.cache-meta.outputs.tags }}
64+
cache-to: type=registry,ref=${{ steps.cache-meta.outputs.tags }},mode=max
65+
labels: ${{ steps.build-meta.outputs.labels }}
66+
provenance: mode=max
67+
sbom: true
68+
tags: ${{ steps.get-registry.outputs.registry }}
69+
outputs: type=image,push-by-digest=true,push=true
70+
71+
- id: gen-output
72+
name: Write arch-specific image digest to outputs
73+
run: |
74+
echo "image-${RUNNER_ARCH,,}=${{ steps.get-registry.outputs.registry }}@${{ steps.build.outputs.digest }}" | tee -a "$GITHUB_OUTPUT"
75+
76+
merge:
77+
runs-on: ubuntu-24.04
78+
needs: build
79+
env:
80+
DOCKER_APP_IMAGE_ARM64: ${{ needs.build.outputs.image-arm64 }}
81+
DOCKER_APP_IMAGE_X64: ${{ needs.build.outputs.image-x64 }}
82+
outputs:
83+
image: ${{ steps.meta.outputs.tags }}
84+
steps:
85+
- name: Checkout code
86+
uses: actions/checkout@v4
87+
88+
- name: Set up Docker Buildx
89+
uses: docker/setup-buildx-action@v3
90+
91+
- name: Login to GitHub Container Registry
92+
uses: docker/login-action@v3
93+
with:
94+
registry: ghcr.io
95+
username: ${{ github.actor }}
96+
password: ${{ secrets.GITHUB_TOKEN }}
97+
98+
- id: meta
99+
name: Generate tag for the app image
100+
uses: docker/metadata-action@v5
101+
with:
102+
images: ghcr.io/${{ github.repository }}
103+
tags: type=sha,suffix=${{ env.BUILD_SUFFIX }}
104+
105+
- name: Push the multi-platform app image
106+
run: |
107+
docker buildx imagetools create \
108+
--tag "$DOCKER_METADATA_OUTPUT_TAGS" \
109+
"$DOCKER_APP_IMAGE_ARM64" "$DOCKER_APP_IMAGE_X64"
110+
111+
test:
112+
runs-on: ubuntu-24.04
113+
needs: merge
114+
env:
115+
COMPOSE_FILE: docker-compose.yml:docker-compose.ci.yml
116+
DOCKER_APP_IMAGE: ${{ needs.merge.outputs.image }}
117+
steps:
118+
- name: Checkout code
119+
uses: actions/checkout@v4
120+
121+
- name: Set up Docker Compose
122+
uses: docker/setup-compose-action@v1
123+
124+
- name: Login to GitHub Container Registry
125+
uses: docker/login-action@v3
126+
with:
127+
registry: ghcr.io
128+
username: ${{ github.actor }}
129+
password: ${{ secrets.GITHUB_TOKEN }}
130+
131+
- name: Setup the stack
132+
run: |
133+
docker compose build --quiet
134+
docker compose pull --quiet
135+
docker compose up --wait
136+
docker compose exec app rails assets:precompile db:prepare geoblacklight:index:seed
137+
docker compose exec -e RAILS_ENV=test app rails db:prepare geoblacklight:index:seed
138+
docker compose exec -u root app chown -R geodata:geodata artifacts
139+
140+
- name: Run RSpec
141+
if: ${{ always() }}
142+
run: |
143+
docker compose exec -e RAILS_ENV=test app rspec --format progress --format html --out artifacts/rspec.html
144+
145+
- name: Run Rubocop
146+
if: ${{ always() }}
147+
run: |
148+
docker compose exec -e RAILS_ENV=test app rubocop --format progress --format html --out artifacts/rubocop.html
149+
150+
- name: Copy out artifacts
151+
if: ${{ always() }}
152+
run: |
153+
docker compose cp app:/opt/app/artifacts ./
154+
docker compose logs > artifacts/docker-compose-services.log
155+
docker compose config > artifacts/docker-compose.merged.yml
156+
157+
- name: Upload the test report
158+
if: ${{ always() }}
159+
uses: actions/upload-artifact@v4
160+
with:
161+
name: GeoData Build Report (${{ github.run_id }}_${{ github.run_attempt }})
162+
path: artifacts/*
163+
if-no-files-found: error
164+
165+
push:
166+
runs-on: ubuntu-24.04
167+
needs:
168+
- merge
169+
- test
170+
env:
171+
DOCKER_APP_IMAGE: ${{ needs.merge.outputs.image }}
172+
steps:
173+
- name: Checkout code
174+
uses: actions/checkout@v4
175+
176+
- name: Login to GitHub Container Registry
177+
uses: docker/login-action@v3
178+
with:
179+
registry: ghcr.io
180+
username: ${{ github.actor }}
181+
password: ${{ secrets.GITHUB_TOKEN }}
182+
183+
- name: Produce permanent image tags
184+
uses: docker/metadata-action@v5
185+
with:
186+
images: ghcr.io/${{ github.repository }}
187+
tags: |
188+
type=sha
189+
type=ref,event=branch
190+
type=raw,value=latest,enable={{is_default_branch}}
191+
192+
- name: Retag and push the image
193+
run: |
194+
docker pull "$DOCKER_APP_IMAGE"
195+
echo "$DOCKER_METADATA_OUTPUT_TAGS" | tr ' ' '\n' | xargs -n1 docker tag "$DOCKER_APP_IMAGE"
196+
docker push --all-tags "$(echo "$DOCKER_APP_IMAGE" | cut -f1 -d:)"

‎.github/workflows/docker-ci.yml‎

Lines changed: 0 additions & 14 deletions
This file was deleted.

‎.github/workflows/release.yml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Push Release Tags
2+
3+
on:
4+
push:
5+
tags:
6+
- '**'
7+
workflow_dispatch:
8+
9+
env:
10+
DOCKER_METADATA_SET_OUTPUT_ENV: 'true'
11+
12+
jobs:
13+
retag:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout code
17+
uses: actions/checkout@v4
18+
19+
- name: Set up Docker Buildx
20+
uses: docker/setup-buildx-action@v3
21+
22+
- name: Login to GitHub Container Registry
23+
uses: docker/login-action@v3
24+
with:
25+
registry: ghcr.io
26+
username: ${{ github.actor }}
27+
password: ${{ secrets.GITHUB_TOKEN }}
28+
29+
- name: Determine the sha-based image tag to retag
30+
id: get-base-image
31+
uses: docker/metadata-action@v5
32+
with:
33+
images: ghcr.io/${{ github.repository }}
34+
tags: type=sha
35+
36+
- name: Verify that the image was previously built
37+
env:
38+
BASE_IMAGE: ${{ steps.get-base-image.outputs.tags }}
39+
run: |
40+
docker pull "$BASE_IMAGE"
41+
42+
- name: Produce release tags
43+
id: tag-meta
44+
uses: docker/metadata-action@v5
45+
with:
46+
images: ghcr.io/${{ github.repository }}
47+
flavor: latest=false
48+
tags: |
49+
type=ref,event=tag
50+
type=semver,pattern={{major}}
51+
type=semver,pattern={{major}}.{{minor}}
52+
type=semver,pattern={{version}}
53+
54+
- name: Retag the pulled image
55+
env:
56+
BASE_IMAGE: ${{ steps.get-base-image.outputs.tags }}
57+
run: |
58+
echo "$DOCKER_METADATA_OUTPUT_TAGS" | tr ' ' '\n' | xargs -n1 docker tag "$BASE_IMAGE"
59+
docker push --all-tags "$(echo "$BASE_IMAGE" | cut -f1 -d:)"

‎docker-compose.ci.yml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
services:
44
app:
55
build: !reset
6+
environment:
7+
- CAPYBARA_SAVE_PATH=/opt/app/artifacts
68
image: ${DOCKER_APP_IMAGE}
79
depends_on:
810
- selenium
@@ -12,4 +14,3 @@ services:
1214

1315
volumes:
1416
artifacts:
15-

‎spec/rails_helper.rb‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@
4343
Capybara.server_host = '0.0.0.0'
4444
Capybara.always_include_port = true
4545
Capybara.run_server = false
46+
Capybara.save_path = ENV['CAPYBARA_SAVE_PATH'] if ENV['CAPYBARA_SAVE_PATH']
4647

4748
RSpec.configure do |config|
4849
config.include CommonHelpers

‎spec/system/restricted_access_spec.rb‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
RSpec.describe 'View Restricted Data' do
44
let(:app_hostname) { IPSocket.getaddress(Socket.gethostname) }
5-
let(:cas_url) { "/cas/login?service=http://#{app_hostname}:3000/users/auth/calnet/callback?url=http://#{app_hostname}:3000/catalog/berkeley-s7b12n" }
5+
let(:cas_url) { "/cas/login?service=http://#{app_hostname}:3000/users/auth/calnet/callback?url=http://#{app_hostname}:3000/catalog/#{CommonHelpers::RESTRICTED_RECORD_ID}" }
66
before do
77
view_record(CommonHelpers::RESTRICTED_RECORD_ID)
88
end
@@ -13,6 +13,8 @@
1313

1414
it 'open calnet login page when clicking login to view and download link' do
1515
find('.btn.btn-default').click
16+
puts page
17+
puts page.current_url
1618
decoded_path_and_query = decoded_url(page.current_url)
1719
expect(decoded_path_and_query).to eq(cas_url)
1820
end

0 commit comments

Comments
 (0)