projectsyn / commodore-component-template Goto Github PK

Context

Recent versions of Docker Engine (20.10) and Podman (at least v2 and newer) support flag --pull always to specify that images should always be pulled. We should use this, as long as we're using :latest image tags for the container images we use in the component's Makefile.vars.mk`:

Alternatives

• Switch to fixed image tags, and deal with renovate PRs on the template and the cascading PRs to update all components.

Context

We may want to add a make target which lints golden test outputs with kubeval to the component template.

This was originally discussed in projectsyn/modulesync-control#25.

Context

We currently mark the make target for component compile as phony. This causes the component to be recompiled, regardless of whether that's necessary. By changing the target to a non-phony target we could leverage make's smart rebuilding for targets which need the compiled component (tests/golden diff/kubent/custom targets operating on the golden test outputs).

While this is not providing a big benefit for many components as we mainly use the targets based on .compile when making changes to the component implementation, there are some cases (e.g. rendering documentation from compiled manifests) where we save some time by reusing the compiled component manifests if no inputs have changed.

The original PR on the modulesync-control repo (projectsyn/modulesync-control#58) keeps the phony `.compile target, so that components which have custom make rules which depend on that target continue to work unchanged.

The current template only has a minimal .editorconfig configuration for golden test outputs:

We had a more comprehensive config in the modulesync template:

https://github.com/projectsyn/modulesync-control/blob/bb736acbff62068695b525333ccc0184085bfb75/moduleroot/.editorconfig.erb#L32-L37

Additionally, because we've migrated existing components for which golden tests were disabled/didn't exist yet at creation time to a template version which unconditionally added the minimal config, we'll probably run into some merge conflicts after updating the template to use the more comprehensive configuration which was present in modulesync.

Actual Behavior

Editorconfig linting fails after enabling golden tests for a component which was originally templated without golden tests (see e.g. projectsyn/component-grafana-helm#26)

Expected Behavior

Editorconfig linting passes after enabling golden tests for a component which was originally templated without golden tests.

Context

We may want to make the YAML linting more strict, disallowing warnings emitted by yamllint. Additionally, we may want to run YAML linting for the yaml files which are part of the template management (e.g. GitHub actions for this repository).

Originally submitted in projectsyn/modulesync-control#73
See also projectsyn/commodore#468

Context

The Commodore command component sync doesn't require that all managed repositories use the same default branch name. We can now add main as a supported default branch to the component template.

Originally requested in projectsyn/commodore#334