From 46867bf445af33cb0fc6af83cf276be57dc7d5f3 Mon Sep 17 00:00:00 2001 From: Wayne Starr Date: Wed, 23 Oct 2024 13:55:34 -0600 Subject: [PATCH] chore: silver badge, streamline README and GH permissions --- .github/workflows/ci-docs-shim.yaml | 4 ++++ .github/workflows/commitlint.yaml | 4 ++++ .github/workflows/lint.yaml | 4 ++++ README.md | 14 ++++---------- 4 files changed, 16 insertions(+), 10 deletions(-) diff --git a/.github/workflows/ci-docs-shim.yaml b/.github/workflows/ci-docs-shim.yaml index b7f36e3..25d3f50 100644 --- a/.github/workflows/ci-docs-shim.yaml +++ b/.github/workflows/ci-docs-shim.yaml @@ -8,6 +8,10 @@ on: branches: [main] types: [milestoned, opened, synchronize] +# Permissions for the GITHUB_TOKEN used by the workflow. +permissions: + contents: read # Allows reading the content of the repository. + jobs: validate: strategy: diff --git a/.github/workflows/commitlint.yaml b/.github/workflows/commitlint.yaml index 668de4a..4d2bded 100644 --- a/.github/workflows/commitlint.yaml +++ b/.github/workflows/commitlint.yaml @@ -8,6 +8,10 @@ on: branches: [main] types: [milestoned, opened, edited, synchronize] +# Permissions for the GITHUB_TOKEN used by the workflow. +permissions: + contents: read # Allows reading the content of the repository. + jobs: validate: uses: defenseunicorns/uds-common/.github/workflows/callable-commitlint.yaml@c52077c870a576d01f169f96d74d1b393c6488ba # v1.1.2 diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index be6fb18..ee594a2 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -9,6 +9,10 @@ on: # milestoned is added here as a workaround for release-please not triggering PR workflows (PRs should be added to a milestone to trigger the workflow). types: [milestoned, opened, reopened, synchronize] +# Permissions for the GITHUB_TOKEN used by the workflow. +permissions: + contents: read # Allows reading the content of the repository. + jobs: validate: uses: defenseunicorns/uds-common/.github/workflows/callable-lint.yaml@c52077c870a576d01f169f96d74d1b393c6488ba # v1.1.2 diff --git a/README.md b/README.md index 897d626..687420a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # 🏭 UDS Renovate Package +[Made for UDS](https://github.com/defenseunicorns/uds-core) [![Latest Release](https://img.shields.io/github/v/release/defenseunicorns/uds-package-renovate)](https://github.com/defenseunicorns/uds-package-renovate/releases) [![Build Status](https://img.shields.io/github/actions/workflow/status/defenseunicorns/uds-package-renovate/release.yaml)](https://github.com/defenseunicorns/uds-package-renovate/actions/workflows/release.yaml) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/defenseunicorns/uds-package-renovate/badge)](https://api.securityscorecards.dev/projects/github.com/defenseunicorns/uds-package-renovate) @@ -8,18 +9,11 @@ This package is designed for use as part of a [UDS Software Factory](https://git ## Optional Dependencies -Renovate can be configured to persist it's cache to a Redis/Valkey instance, either in cluster or external. +Renovate requires a version control system (like [`uds-package-gitlab`](https://github.com/defenseunicorns/uds-package-gitlab)) and can be configured to persist it's cache to a Redis/Valkey instance, either in cluster or external. For local testing and CI, Renovate is bundled with [uds-package-valkey](ghcr.io/defenseunicorns/packages/uds/uds-package-valkey). -## Flavors - -| Flavor | Description | Example Creation | -| ------ | ----------- | ---------------- | -| `upstream` | Uses upstream images within the package | `zarf package create . -f upstream` | -| `registry1` | Uses images from registry1.dso.mil within the package | `zarf package create . -f registry1` | - -> **_NOTE:_** `registry1` flavor only supports the amd64 architecture +To learn more about how to configure these and other options refer to the [configuration documentation](./docs/configuration.md). ## Releases @@ -37,4 +31,4 @@ Please see the [CONTRIBUTING.md](./CONTRIBUTING.md) ## Development -When developing this package it is ideal to utilize the json schemas for UDS Bundles, Zarf Packages and Maru Tasks. This involves configuring your IDE to provide schema validation for the respective files used by each application. For guidance on how to set up this schema validation, please refer to the [guide](https://github.com/defenseunicorns/uds-common/blob/main/docs/development-ide-configuration.md) in uds-common. +When developing this package it is ideal to utilize the json schemas for UDS Bundles, Zarf Packages and Maru Tasks. This involves configuring your IDE to provide schema validation for the respective files used by each application. For guidance on how to set up this schema validation, please refer to the [guide](https://github.com/defenseunicorns/uds-common/blob/main/docs/uds-packages/development/development-ide-configuration.md) in uds-common.