uptest

module
v0.12.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 20, 2024 License: Apache-2.0

README

official-providers-ci

[!IMPORTANT] Uptest framework was contributed to CNCF and now located at https://github.com/crossplane/uptest

Repository for the CI tooling of the Upbound official providers repositories:

  • crddiff: A tool for checking breaking API changes between two CRD OpenAPI v3 schemas. The schemas can come from either two revisions of a CRD, or from the versions declared in a single CRD.
  • buildtagger: A tool for generating build tags (constraints) for the source modules of the official provider families.
  • lint-provider-family: A linter for the official provider families. Checks whether all CRDs generated for a provider family are packaged in the corresponding service-scoped provider and checks the provider metadata.
  • perf: A tool for running performance experiments in the official provider repositories and for collecting & reporting the CPU & Memory utilizations and time to readiness (TTR) for MRs in these experiments.
  • ttr: A tool that reports the time-to-readiness (TTR) measurements for a subset of the managed resources in a Kubernetes cluster.
  • updoc: Upbound enhanced document processor.

This repository is also the home of the Upbound official providers reusable workflows:

  • .github/workflows/provider-ci.yml: A reusable CI workflow for building, linting & validating the official providers.
  • .github/workflows/pr-comment-trigger.yml: A reusable workflow for triggering uptest runs using a specified set of example manifests via pull request comments.
  • .github/workflows/provider-publish-service-artifacts.yml: A reusable workflow for building the official provider families and pushing their packages to the Upbound registry.
  • .github/workflows/native-provider-bump.yml: A reusable workflow for bumping the underlying Terraform provider versions of upjet-based official providers.
  • .github/workflows/provider-backport.yml: A reusable workflow for opening backport PRs in the specified release branches by inspecting the labels on merged PRs.
  • .github/workflows/provider-tag.yml: A reusable workflow for tagging commits in the release process.
  • .github/workflows/provider-updoc.yml: A reusable workflow for running updoc and publishing the provider documentation to the Upbound marketplace.
  • .github/workflows/scan.yml: A reusable workflow for running Trivy scans in the official provider repositories.
  • .github/workflows/provider-commands.yml: A reusable workflow for opening backport PRs in the specified release branches via PR comments.

Report a Bug

For filing bugs, suggesting improvements, or requesting new features, please open an issue.

Licensing

Uptest is under the Apache 2.0 license.

Directories

Path Synopsis
cmd
buildtagger
main package for the buildtagger application which is used in the official provider repositories to generate build tags for the provider families.
main package for the buildtagger application which is used in the official provider repositories to generate build tags for the provider families.
cleanupexamples
main package for the cleanupexamples tooling, the tool to remove uptest-specific code from published examples on the marketplace
main package for the cleanupexamples tooling, the tool to remove uptest-specific code from published examples on the marketplace
crddiff
main package for the uptest tooling.
main package for the uptest tooling.
linter/lint-provider-family
main package for the ssop-linter tool, a linter for checking the packages of a provider family.
main package for the ssop-linter tool, a linter for checking the packages of a provider family.
perf
Package main
Package main
perf/internal
Package internal contains methods about quantifying the provider metrics
Package internal contains methods about quantifying the provider metrics
perf/internal/common
Package common is for some common functions for tooling
Package common is for some common functions for tooling
perf/internal/managed
Package managed contains functions about managed resource management during the experiment
Package managed contains functions about managed resource management during the experiment
ttr
main package for the ttr tool, which reports the time-to-readiness measurements for all managed resources in a cluster.
main package for the ttr tool, which reports the time-to-readiness measurements for all managed resources in a cluster.
updoc
Package main is the main package for updoc, the tool for publishing official provider docs.
Package main is the main package for updoc, the tool for publishing official provider docs.
internal
crdschema
Package crdschema contains the implementation for crddiff, a utility for comparing two CRD schemas for detecting and reporting changes between those schemas.
Package crdschema contains the implementation for crddiff, a utility for comparing two CRD schemas for detecting and reporting changes between those schemas.
updoc
Package updoc package implements updoc, the tool for publishing official provider docs.
Package updoc package implements updoc, the tool for publishing official provider docs.
version
Package version contains the version of provider-aws repo
Package version contains the version of provider-aws repo

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL