From 536630cbcd23fc5512580bdf8bcdbb74d7e85e8a Mon Sep 17 00:00:00 2001 From: stefanprodan Date: Thu, 1 Oct 2020 16:56:57 +0300 Subject: [PATCH 1/2] Update roadmap after v0.1 release --- .github/workflows/docs.yaml | 30 ++++++++++++++++-------------- docs/roadmap/index.md | 5 ++--- 2 files changed, 18 insertions(+), 17 deletions(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 7d5f97f1..3d35c9ab 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -3,6 +3,8 @@ on: push: branches: - docs* + - roadmap* + - master tags: - '*' @@ -22,35 +24,35 @@ jobs: { # source-controller CRDs SOURCE_VER=$(controller_version source-controller) - curl -# -f "https://raw.githubusercontent.com/fluxcd/source-controller/$SOURCE_VER/docs/api/source.md" > docs/components/source/api.md - curl -# -f "https://raw.githubusercontent.com/fluxcd/source-controller/$SOURCE_VER/docs/spec/v1beta1/gitrepositories.md" > docs/components/source/gitrepositories.md - curl -# -f "https://raw.githubusercontent.com/fluxcd/source-controller/$SOURCE_VER/docs/spec/v1beta1/helmrepositories.md" > docs/components/source/helmrepositories.md - curl -# -f "https://raw.githubusercontent.com/fluxcd/source-controller/$SOURCE_VER/docs/spec/v1beta1/helmcharts.md" > docs/components/source/helmcharts.md - curl -# -f "https://raw.githubusercontent.com/fluxcd/source-controller/$SOURCE_VER/docs/spec/v1beta1/buckets.md" > docs/components/source/buckets.md + curl -# -Lf "https://raw.githubusercontent.com/fluxcd/source-controller/$SOURCE_VER/docs/api/source.md" > docs/components/source/api.md + curl -# -Lf "https://raw.githubusercontent.com/fluxcd/source-controller/$SOURCE_VER/docs/spec/v1beta1/gitrepositories.md" > docs/components/source/gitrepositories.md + curl -# -Lf "https://raw.githubusercontent.com/fluxcd/source-controller/$SOURCE_VER/docs/spec/v1beta1/helmrepositories.md" > docs/components/source/helmrepositories.md + curl -# -Lf "https://raw.githubusercontent.com/fluxcd/source-controller/$SOURCE_VER/docs/spec/v1beta1/helmcharts.md" > docs/components/source/helmcharts.md + curl -# -Lf "https://raw.githubusercontent.com/fluxcd/source-controller/$SOURCE_VER/docs/spec/v1beta1/buckets.md" > docs/components/source/buckets.md } { # kustomize-controller CRDs KUSTOMIZE_VER=$(controller_version kustomize-controller) - curl -# -f "https://raw.githubusercontent.com/fluxcd/kustomize-controller/$KUSTOMIZE_VER/docs/api/kustomize.md" > docs/components/kustomize/api.md - curl -# -f "https://raw.githubusercontent.com/fluxcd/kustomize-controller/$KUSTOMIZE_VER/docs/spec/v1beta1/kustomization.md" > docs/components/kustomize/kustomization.md + curl -# -Lf "https://raw.githubusercontent.com/fluxcd/kustomize-controller/$KUSTOMIZE_VER/docs/api/kustomize.md" > docs/components/kustomize/api.md + curl -# -Lf "https://raw.githubusercontent.com/fluxcd/kustomize-controller/$KUSTOMIZE_VER/docs/spec/v1beta1/kustomization.md" > docs/components/kustomize/kustomization.md } { # helm-controller CRDs HELM_VER=$(controller_version helm-controller) - curl -# -f "https://raw.githubusercontent.com/fluxcd/helm-controller/$HELM_VER/docs/api/helmrelease.md" > docs/components/helm/api.md - curl -# -f "https://raw.githubusercontent.com/fluxcd/helm-controller/$HELM_VER/docs/spec/v2beta1/helmreleases.md" > docs/components/helm/helmreleases.md + curl -# -Lf "https://raw.githubusercontent.com/fluxcd/helm-controller/$HELM_VER/docs/api/helmrelease.md" > docs/components/helm/api.md + curl -# -Lf "https://raw.githubusercontent.com/fluxcd/helm-controller/$HELM_VER/docs/spec/v2beta1/helmreleases.md" > docs/components/helm/helmreleases.md } { # notification-controller CRDs NOTIFICATION_VER=$(controller_version notification-controller) - curl -# -f "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/api/notification.md" > docs/components/notification/api.md - curl -# -f "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/spec/v1beta1/event.md" > docs/components/notification/event.md - curl -# -f "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/spec/v1beta1/alert.md" > docs/components/notification/alert.md - curl -# -f "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/spec/v1beta1/provider.md" > docs/components/notification/provider.md - curl -# -f "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/spec/v1beta1/receiver.md" > docs/components/notification/receiver.md + curl -# -Lf "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/api/notification.md" > docs/components/notification/api.md + curl -# -Lf "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/spec/v1beta1/event.md" > docs/components/notification/event.md + curl -# -Lf "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/spec/v1beta1/alert.md" > docs/components/notification/alert.md + curl -# -Lf "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/spec/v1beta1/provider.md" > docs/components/notification/provider.md + curl -# -Lf "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/spec/v1beta1/receiver.md" > docs/components/notification/receiver.md } { diff --git a/docs/roadmap/index.md b/docs/roadmap/index.md index b09a414b..4c39a806 100644 --- a/docs/roadmap/index.md +++ b/docs/roadmap/index.md @@ -20,7 +20,7 @@ and [FluxCloud](https://github.com/justinbarrick/fluxcloud) notifications. Goals -- Offer an in-place migration tool for those that are using Flux in read-only mode to synchronize plain manifests +- Offer a migration guide for those that are using Flux in read-only mode to synchronize plain manifests - Offer a migration guide for those that are using Flux in read-only mode to synchronize Kustomize overlays - :material-check-bold: [Offer a dedicated component for forwarding events to external messaging platforms](https://toolkit.fluxcd.io/guides/notifications/) @@ -37,8 +37,7 @@ Tasks - [x] Design the notifications and events filtering API - [x] Implement a notification controller for Slack, MS Teams, Discord, Rocket - [x] Implement Prometheus metrics in source and kustomize controllers -- [ ] Review the git source and kustomize APIs -- [ ] Implement the migration command in gotk +- [x] Review the git source and kustomize APIs - [ ] Create a migration guide for `flux.yaml` kustomize users - [x] Include support for SOPS From 249d0d43de291af0a13d0958a906d225aa303b20 Mon Sep 17 00:00:00 2001 From: Hidde Beydals Date: Thu, 1 Oct 2020 16:39:48 +0200 Subject: [PATCH 2/2] docs: hotfix component versions --- .github/workflows/docs.yaml | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 3d35c9ab..c18cb81f 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -16,6 +16,12 @@ jobs: - name: Checkout master uses: actions/checkout@v1 - name: Copy assets + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + SOURCE_VER: ${{ 'v0.1.0' }} + KUSTOMIZE_VER: ${{ 'v0.1.0' }} + HELM_VER: ${{ 'v0.1.0' }} + NOTIFICATION_VER: ${{ 'v0.1.0' }} run: | controller_version() { sed -n "s/\(.*$1\/.*?ref=\)//p;n" "manifests/bases/$1/kustomization.yaml" @@ -23,7 +29,7 @@ jobs: { # source-controller CRDs - SOURCE_VER=$(controller_version source-controller) + # SOURCE_VER=$(controller_version source-controller) curl -# -Lf "https://raw.githubusercontent.com/fluxcd/source-controller/$SOURCE_VER/docs/api/source.md" > docs/components/source/api.md curl -# -Lf "https://raw.githubusercontent.com/fluxcd/source-controller/$SOURCE_VER/docs/spec/v1beta1/gitrepositories.md" > docs/components/source/gitrepositories.md curl -# -Lf "https://raw.githubusercontent.com/fluxcd/source-controller/$SOURCE_VER/docs/spec/v1beta1/helmrepositories.md" > docs/components/source/helmrepositories.md @@ -33,21 +39,21 @@ jobs: { # kustomize-controller CRDs - KUSTOMIZE_VER=$(controller_version kustomize-controller) + # KUSTOMIZE_VER=$(controller_version kustomize-controller) curl -# -Lf "https://raw.githubusercontent.com/fluxcd/kustomize-controller/$KUSTOMIZE_VER/docs/api/kustomize.md" > docs/components/kustomize/api.md curl -# -Lf "https://raw.githubusercontent.com/fluxcd/kustomize-controller/$KUSTOMIZE_VER/docs/spec/v1beta1/kustomization.md" > docs/components/kustomize/kustomization.md } { # helm-controller CRDs - HELM_VER=$(controller_version helm-controller) + # HELM_VER=$(controller_version helm-controller) curl -# -Lf "https://raw.githubusercontent.com/fluxcd/helm-controller/$HELM_VER/docs/api/helmrelease.md" > docs/components/helm/api.md curl -# -Lf "https://raw.githubusercontent.com/fluxcd/helm-controller/$HELM_VER/docs/spec/v2beta1/helmreleases.md" > docs/components/helm/helmreleases.md } { # notification-controller CRDs - NOTIFICATION_VER=$(controller_version notification-controller) + # NOTIFICATION_VER=$(controller_version notification-controller) curl -# -Lf "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/api/notification.md" > docs/components/notification/api.md curl -# -Lf "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/spec/v1beta1/event.md" > docs/components/notification/event.md curl -# -Lf "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/spec/v1beta1/alert.md" > docs/components/notification/alert.md