diff --git a/.gitea/workflows/check-version.yml b/.gitea/workflows/check-version.yml index edd0fad..92cf6af 100644 --- a/.gitea/workflows/check-version.yml +++ b/.gitea/workflows/check-version.yml @@ -16,6 +16,8 @@ on: env: GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }} + GIT_TAG_PREFIX: ${{ fromJson(inputs.env_json).GIT_TAG_PREFIX || '' }} + VERSION_FILE: ${{ fromJson(inputs.env_json).VERSION_FILE || '' }} jobs: check: @@ -28,7 +30,13 @@ jobs: - name: Check existing artifact and calculate version run: | - if [ -f VERSION ]; then + if [ -n "${VERSION_FILE}" ]; then + if echo "${VERSION_FILE}" | grep -q '\.json$'; then + RAW_VERSION=$(jq -r '.version' "${VERSION_FILE}") + else + RAW_VERSION=$(cat "${VERSION_FILE}" | tr -d '[:space:]') + fi + elif [ -f VERSION ]; then RAW_VERSION=$(cat VERSION | tr -d '[:space:]') elif [ -f package.json ]; then RAW_VERSION=$(jq -r '.version' package.json) @@ -44,7 +52,10 @@ jobs: TAGS_JSON=$(curl -s -f -H "Authorization: token $GITEA_TOKEN" \ "${{ gitea.server_url }}/api/v1/repos/${{ gitea.repository }}/tags") - TAG=$(echo "$TAGS_JSON" | jq -r 'if type == "array" then .[] | select(.commit.sha == "${{ github.sha }}") | .name else empty end' | head -1) + TAG=$(echo "$TAGS_JSON" | jq -r --arg prefix "${GIT_TAG_PREFIX}" ' + if type == "array" then + .[] | select(.commit.sha == "${{ github.sha }}" and (.name | startswith($prefix))) | .name + else empty end' | head -1) mkdir -p /tmp/build-ctx @@ -55,7 +66,7 @@ jobs: else echo "ARTIFACT_EXISTS=false" > /tmp/build-ctx/build.env - HIGHEST_PATCH=$(echo "$TAGS_JSON" | jq -r --arg bv "$BASE_VERSION." ' + HIGHEST_PATCH=$(echo "$TAGS_JSON" | jq -r --arg prefix "${GIT_TAG_PREFIX}" --arg bv "${GIT_TAG_PREFIX}${BASE_VERSION}." ' if type == "array" then .[] | .name | select(startswith($bv)) | sub($bv; "") | tonumber else empty end' | sort -rn | head -1) if [ -z "$HIGHEST_PATCH" ]; then NEXT_PATCH=0; else NEXT_PATCH=$((HIGHEST_PATCH + 1)); fi diff --git a/.gitea/workflows/docker-build-push.yml b/.gitea/workflows/docker-build-push.yml index 17e4deb..ccd5f65 100644 --- a/.gitea/workflows/docker-build-push.yml +++ b/.gitea/workflows/docker-build-push.yml @@ -23,6 +23,7 @@ env: DOCKER_IMAGE_NAME: ${{ fromJson(inputs.env_json).DOCKER_IMAGE_NAME || '' }} DOCKER_UI_URL: ${{ fromJson(inputs.env_json).DOCKER_UI_URL || '' }} DOCKERFILE: ${{ fromJson(inputs.env_json).DOCKERFILE || 'Dockerfile' }} + GIT_TAG_PREFIX: ${{ fromJson(inputs.env_json).GIT_TAG_PREFIX || '' }} VERSION: ${{ inputs.version }} concurrency: @@ -50,7 +51,8 @@ jobs: --label "git.commitBy=${{ github.actor }}" \ --label "build.date=${NOW}" \ -f "${DOCKERFILE}" \ - -t "${DOCKER_IMAGE_NAME}:${VERSION}" . + -t "${DOCKER_IMAGE_NAME}:${VERSION}" \ + -t "${DOCKER_IMAGE_NAME}:latest" . REGISTRY="${DOCKER_REGISTRY:?DOCKER_REGISTRY not set in env.conf}" IMAGE="${DOCKER_IMAGE_NAME:?DOCKER_IMAGE_NAME not set in env.conf}" @@ -62,6 +64,12 @@ jobs: docker tag "${DOCKER_IMAGE_NAME}:${VERSION}" "$FULL_IMAGE" echo "$DOCKER_PASSWORD" | docker login "$REGISTRY_HOST" -u "$DOCKER_USERNAME" --password-stdin docker push "$FULL_IMAGE" + + FULL_LATEST="${REGISTRY}/${IMAGE}:latest" + echo "Pushing ${FULL_LATEST} ..." + docker tag "${DOCKER_IMAGE_NAME}:latest" "$FULL_LATEST" + docker push "$FULL_LATEST" + docker logout "$REGISTRY_HOST" - name: Report status SUCCESS @@ -69,7 +77,7 @@ jobs: run: | CONTAINER_URL="" if [ -n "${DOCKER_UI_URL:-}" ] && [ -n "${VERSION:-}" ]; then - CONTAINER_URL="${DOCKER_UI_URL}/${VERSION}" + CONTAINER_URL="${DOCKER_UI_URL}/${DOCKER_IMAGE_NAME}/${VERSION}" fi bash .ci/scripts/report-status.sh success "Docker build & push ${VERSION} OK" ci-docker-build-push "" "$CONTAINER_URL" @@ -94,7 +102,7 @@ jobs: "$SERVER_URL/api/v1/repos/${{ github.repository }}/tags" \ -H "Authorization: token $GITEA_TOKEN" \ -H "Content-Type: application/json" \ - -d "{\"tag_name\": \"${VERSION}\", \"message\": \"Build #$RUN_NUMBER\", \"target\": \"$SHA\"}") + -d "{\"tag_name\": \"${GIT_TAG_PREFIX}${VERSION}\", \"message\": \"Build #$RUN_NUMBER\", \"target\": \"$SHA\"}") if [ "$HTTP_CODE" = "201" ] || [ "$HTTP_CODE" = "409" ]; then exit 0 diff --git a/.gitea/workflows/example-gitea-env.conf b/.gitea/workflows/example-gitea-env.conf index 51c5644..7d35737 100644 --- a/.gitea/workflows/example-gitea-env.conf +++ b/.gitea/workflows/example-gitea-env.conf @@ -2,5 +2,5 @@ GITEA_API_URL=https://gitea.app.keskikuja.site GIT_PAGES_URL=https://ci-reports.helm-dev.keskikuja.site DOCKER_REGISTRY=gitea.app.keskikuja.site/niko DOCKER_IMAGE_NAME=gitea-ci-library-test-image -DOCKER_UI_URL=https://gitea.app.keskikuja.site/niko/-/packages/container/gitea-ci-library-test-image +DOCKER_UI_URL=https://gitea.app.keskikuja.site/niko/-/packages/container #DOCKERFILE=Dockerfile.platform diff --git a/README.md b/README.md index 517bdf5..aa26388 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,11 @@ Reusable workflow -kirjasto Gitea Actionsille. Lisätietoja: [docs/](docs/) **Consumer-käyttöönotto:** [docs/consumer-guide.md](docs/consumer-guide.md) — vaiheittainen ohje uuden projektin liittämiseen +**Single repo & monorepo:** Kirjasto toimii molemmissa. Monorepo-tuki +polkusuodatuksella, komponenttikohtaisilla versioilla ja git-tägien +etuliitteillä — jokainen komponentti julkaistaan itsenäisesti omassa +tahdissaan. Katso [docs/consumer-guide.md#monorepo](docs/consumer-guide.md#monorepo). + ## Provider-binding — miten consumer löytää providerin Consumer kutsuu provideria `uses:`-viittauksella. Ei discoveryä — polku kovakoodataan consumerin diff --git a/docs/consumer-guide.md b/docs/consumer-guide.md index aabff78..0bdca4f 100644 --- a/docs/consumer-guide.md +++ b/docs/consumer-guide.md @@ -40,7 +40,7 @@ Jos buildaat Docker-kontteja, lisää: ```ini DOCKER_REGISTRY=gitea.example.com/myorg DOCKER_IMAGE_NAME=my-service -DOCKER_UI_URL=https://gitea.example.com/myorg/-/packages/container/my-service +DOCKER_UI_URL=https://gitea.example.com/myorg/-/packages/container #DOCKERFILE=Dockerfile.platform # valinnainen, oletus Dockerfile ``` @@ -361,6 +361,128 @@ Gitean Settings → Branches → Add Rule: --- +## Monorepo + +Monorepossa yhdestä repossa asuu useampi julkaistava komponentti (esim. +`api/`, `frontend/`). Ratkaisu on yksinkertainen: jokaiselle komponentille +oma conf-tiedosto, jossa on kaikki komponenttikohtainen tieto. Ei +ylöslyöntejä pipelinessa — pelkkä `config_path:` riittää. + +### Ongelmat ja ratkaisut + +| Ongelma | Ratkaisu | +|---|---| +| Monta komponenttia, yksi repo — mikä triggeröi? | `paths:`-filtteri consumer-workflowssa: `push: { paths: ['api/**'] }` | +| Jokaisella komponentilla oma versio | `VERSION_FILE=api/package.json` conf-tiedostossa, `check-version.yml` lukee tämän | +| Git-tägit sekaisin ellei nimiavaruutta | `GIT_TAG_PREFIX=api/` confissa → tägi `api/1.2.3` | +| Eri julkaisutahdit — api voi mennä 3.1 samalla kun frontend on 1.5 | Riippumattomat CI-triggerit, omat versiopolut | + +Kaikki komponenttikohtainen tieto on conf-tiedostossa. `config-provider.yml` +lukee confin sellaisenaan → `GIT_TAG_PREFIX`, `VERSION_FILE`, `DOCKER_IMAGE_NAME` +menevät `env_json`:ään automaattisesti. `check-version.yml` ja +`docker-build-push.yml` lukevat ne sieltä. + +### Komponenttikohtainen conf-tiedosto + +Kaikki conf-tiedostot ovat `.gitea/workflows/`-kansiossa, komponenttikohtaisesti +nimettynä: + +``` +.gitea/workflows/api.gitea-env.conf: +GITEA_API_URL=https://gitea.example.com +GIT_PAGES_URL=https://reports.example.com +DOCKER_REGISTRY=gitea.example.com/myorg +DOCKER_IMAGE_NAME=agent-platform-api +DOCKER_UI_URL=https://gitea.example.com/myorg/-/packages/container +GIT_TAG_PREFIX=api/ +VERSION_FILE=api/package.json + +.gitea/workflows/frontend.gitea-env.conf: +GITEA_API_URL=https://gitea.example.com +GIT_PAGES_URL=https://reports.example.com +DOCKER_REGISTRY=gitea.example.com/myorg +DOCKER_IMAGE_NAME=agent-platform-frontend +DOCKER_UI_URL=https://gitea.example.com/myorg/-/packages/container +GIT_TAG_PREFIX=frontend/ +VERSION_FILE=frontend/package.json +``` + +### Consumer-workflow monorepolle + +Jokainen komponentti saa oman CI-tiedoston. Ainoa parametri on `config_path`: + +`ci-api-main.yml`: +```yaml +name: CI API Main +on: + push: + branches: + - main + paths: + - 'api/**' + +jobs: + load-config: + uses: org/gitea-ci-library/.gitea/workflows/config-provider.yml@v1 + secrets: inherit + with: + config_path: .gitea/workflows/api.gitea-env.conf + + check-version: + needs: [load-config] + uses: org/gitea-ci-library/.gitea/workflows/check-version.yml@v1 + secrets: inherit + with: + env_json: ${{ needs.load-config.outputs.env_json }} + + unit-tests: + needs: [load-config, check-version] + if: needs.check-version.outputs.artifact_exists != 'true' + uses: ./.gitea/workflows/ci-api-tests.yml@main + secrets: inherit + with: + env_json: ${{ needs.load-config.outputs.env_json }} + + build-push: + needs: [load-config, check-version, unit-tests] + if: needs.check-version.outputs.artifact_exists != 'true' + uses: org/gitea-ci-library/.gitea/workflows/docker-build-push.yml@v1 + secrets: inherit + with: + env_json: ${{ needs.load-config.outputs.env_json }} + version: ${{ needs.check-version.outputs.version }} +``` + +### Version elinkaari per komponentti + +`GIT_TAG_PREFIX` takaa että eri komponenttien versiohistoria pysyy erillään. +Git-tägi `api/0.2.3` ei sekoitu frontendin tägiin `frontend/1.5.0` — +vaikka molemmat asuvat samassa repossa. + +`check-version.yml` suodattaa ja laskee seuraavan patchin vain kyseisen +komponentin etuliitteellä. Kun `api/`:n `package.json` on `0.2` ja tägit +ovat `api/0.2.0`, `api/0.2.1` → seuraava on `api/0.2.2`. Frontendin +`1.5.0` jätetään huomiotta tässä laskennassa — eri komponentti, täysin +itsenäinen. + +### Artifaktin tallennus ja idempotenttius + +Idempotenttius toimii komponenttikohtaisesti: jos commitilla on jo +`api/0.2.3`-tägi, api:n pipeline skipataan `if: artifact_exists != 'true'`. +Frontendin tägit eivät vaikuta api:n idempotenttiuteen — jokainen +komponentti tarkistaa vain omat täginsä. + +### Mitä EI kannata tehdä + +- Älä aja kaikkia komponentteja samasta triggeristä — `paths:` pitää + CI:t erillisinä ja julkaisutahdit itsenäisinä +- Älä käytä samaa versionhallintatiedostoa usealle komponentille — jokaisella + oma `package.json` / `VERSION` +- Älä sekoita `DOCKER_UI_URL`:ään image-nimeä confissa — URL on puhdas + container-registryn osoite, image-nimi lisätään automaattisesti +- Älä anna monorepo-parametreja `config-provider.yml`:n kautta — kaikki + kuuluu komponentin omaan conf-tiedostoon + ## Raporttien koonti (Gitea 1.27+) Kun Gitea päivittyy versioon 1.27, `GITHUB_STEP_SUMMARY`-tuki mahdollistaa