This repository has been archived by the owner on Aug 19, 2024. It is now read-only.
Add instructions for installing CI Builds and move install scripts here #182
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Copyright 2023 The Janus IDP Authors | |
# | |
# Licensed under the Apache License, Version 2.0 (the "License"); | |
# you may not use this file except in compliance with the License. | |
# You may obtain a copy of the License at | |
# | |
# http://www.apache.org/licenses/LICENSE-2.0 | |
# | |
# Unless required by applicable law or agreed to in writing, software | |
# distributed under the License is distributed on an "AS IS" BASIS, | |
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
# See the License for the specific language governing permissions and | |
# limitations under the License. | |
name: PR Build operator, bundle, and catalog images | |
on: | |
# /!\ Warning: using the pull_request_target event to be able to read secrets. But using this event without the cautionary measures described below | |
# may allow unauthorized GitHub users to open a “pwn request” and exfiltrate secrets. | |
# As recommended in https://iterative.ai/blog/testing-external-contributions-using-github-actions-secrets, | |
# we are adding an 'authorize' job that checks if the workflow was triggered from a fork PR. In that case, the "external" environment | |
# will prevent the job from running until it's approved manually by human intervention. | |
pull_request_target: | |
types: [opened, synchronize, reopened, ready_for_review] | |
branches: | |
- main | |
- rhdh-1.[0-9]+ | |
- 1.[0-9]+.x | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.event.number || github.event.pull_request.head.ref }} | |
cancel-in-progress: true | |
env: | |
REGISTRY: quay.io | |
jobs: | |
authorize: | |
# The 'external' environment is configured with the odo-maintainers team as required reviewers. | |
# All the subsequent jobs in this workflow 'need' this job, which will require manual approval for PRs coming from external forks. | |
# see list of approvers in OWNERS file | |
environment: | |
${{ (github.event.pull_request.head.repo.full_name == github.repository || | |
contains(fromJSON('["gazarenkov","jianrongzhang89","kadel","nickboldt","rm3l"]'), github.actor)) && 'internal' || 'external' }} | |
runs-on: ubuntu-latest | |
steps: | |
- name: approved | |
run: | | |
echo "✓" | |
pr-build: | |
name: PR Publish | |
runs-on: ubuntu-latest | |
needs: authorize | |
permissions: | |
contents: read | |
packages: write | |
pull-requests: write | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
ref: ${{ github.event.pull_request.head.ref }} | |
repository: ${{ github.event.pull_request.head.repo.full_name }} | |
# check changes in this commit for regex include and exclude matches; pipe to an env var | |
- name: Check for changes to build | |
run: | | |
# don't fail if nothing returned by grep | |
set +e | |
CHANGES="$(git diff --name-only HEAD~1 | \ | |
grep -E "workflows/.+-container-build.yaml|Makefile|bundle/|config/|go.mod|go.sum|.+\.go|docker/|\.dockerignore" | \ | |
grep -v -E ".+_test.go|/.rhdh/")"; | |
echo "Changed files for this commit:" | |
echo "==============================" | |
echo "$CHANGES" | |
echo "==============================" | |
{ | |
echo 'CHANGES<<EOF' | |
echo $CHANGES | |
echo EOF | |
} >> "$GITHUB_ENV" | |
- name: Setup Go | |
# run this stage only if there are changes that match the includes and not the excludes | |
if: ${{ env.CHANGES != '' }} | |
uses: actions/setup-go@v5 | |
with: | |
go-version-file: 'go.mod' | |
- name: Get the last commit short SHA of the PR | |
# run this stage only if there are changes that match the includes and not the excludes | |
if: ${{ env.CHANGES != '' }} | |
run: | | |
SHORT_SHA=$(git rev-parse --short ${{ github.event.pull_request.head.sha }}) | |
echo "SHORT_SHA=$SHORT_SHA" >> $GITHUB_ENV | |
BASE_VERSION=$(grep -E "^VERSION \?=" Makefile | sed -r -e "s/.+= //") # 0.0.1 | |
echo "BASE_VERSION=$BASE_VERSION" >> $GITHUB_ENV | |
- name: Login to quay.io | |
# run this stage only if there are changes that match the includes and not the excludes | |
if: ${{ env.CHANGES != '' }} | |
uses: docker/login-action@v2 | |
with: | |
registry: ${{ env.REGISTRY }} | |
username: ${{ vars.QUAY_USERNAME }} | |
password: ${{ secrets.QUAY_TOKEN }} | |
- name: Build and push operator, bundle, and catalog images | |
# run this stage only if there are changes that match the includes and not the excludes | |
if: ${{ env.CHANGES != '' }} | |
run: | | |
# install skopeo, podman | |
sudo apt-get -y update; sudo apt-get -y install skopeo podman | |
export CONTAINER_ENGINE=podman | |
export VERSION=${{ env.BASE_VERSION }}-pr-${{ github.event.number }}-${{ env.SHORT_SHA }} | |
set -ex | |
# build 3 container images with a 14d expiry | |
CONTAINER_ENGINE=${CONTAINER_ENGINE} VERSION=${VERSION} make lint release-build | |
# now copy images from local cache to quay, using 0.0.1-pr-123-f00cafe and 0.0.1-pr-123 tags | |
for image in operator operator-bundle operator-catalog; do | |
podman push quay.io/janus-idp/${image}:${VERSION} -q | |
skopeo --insecure-policy copy --all docker://quay.io/janus-idp/${image}:${VERSION} docker://quay.io/janus-idp/${image}:${VERSION} | |
skopeo --insecure-policy copy --all docker://quay.io/janus-idp/${image}:${VERSION} docker://quay.io/janus-idp/${image}:${VERSION%-*} | |
done | |
- name: Comment image links in PR | |
# run this stage only if there are changes that match the includes and not the excludes | |
if: ${{ env.CHANGES != '' }} | |
uses: actions/github-script@v6 | |
with: | |
script: | | |
await github.rest.issues.createComment({ | |
issue_number: context.issue.number, | |
owner: context.repo.owner, | |
repo: context.repo.repo, | |
body: 'PR images are available:<br/><ol><li>https://quay.io/janus-idp/operator:${{ env.BASE_VERSION }}-pr-${{ github.event.number }}-${{ env.SHORT_SHA }}</li><li>https://quay.io/janus-idp/operator-bundle:${{ env.BASE_VERSION }}-pr-${{ github.event.number }}-${{ env.SHORT_SHA }}</li><li>https://quay.io/janus-idp/operator-catalog:${{ env.BASE_VERSION }}-pr-${{ github.event.number }}-${{ env.SHORT_SHA }}</li></ol>' | |
}) |