Note on the name of the configuration file #1569
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zubieta
approved these changes
Aug 9, 2024
felixfontein
approved these changes
Aug 13, 2024
Making explicit that only files named `.sops.yaml` will be auto-discovered. And alternative names (like `.sops.yml`) need to be used with the `--config` flag. Signed-off-by: Carlos Zubieta <[email protected]>
Co-authored-by: Felix Fontein <[email protected]> Signed-off-by: Carlos Zubieta <[email protected]>
|
@ErraticMaker thanks for improving the docs! |
tmeijn
pushed a commit
to tmeijn/dotfiles
that referenced
this pull request
Oct 14, 2024
This MR contains the following updates: | Package | Update | Change | |---|---|---| | [getsops/sops](https://github.com/getsops/sops) | patch | `v3.9.0` -> `v3.9.1` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>getsops/sops (getsops/sops)</summary> ### [`v3.9.1`](https://github.com/getsops/sops/releases/tag/v3.9.1) [Compare Source](getsops/sops@v3.9.0...v3.9.1) #### Installation To install `sops`, download one of the pre-built binaries provided for your platform from the artifacts attached to this release. For instance, if you are using Linux on an AMD64 architecture: ```shell ### Download the binary curl -LO https://github.com/getsops/sops/releases/download/v3.9.1/sops-v3.9.1.linux.amd64 ### Move the binary in to your PATH mv sops-v3.9.1.linux.amd64 /usr/local/bin/sops ### Make the binary executable chmod +x /usr/local/bin/sops ``` ##### Verify checksums file signature The checksums file provided within the artifacts attached to this release is signed using [Cosign](https://docs.sigstore.dev/cosign/overview/) with GitHub OIDC. To validate the signature of this file, run the following commands: ```shell ### Download the checksums file, certificate and signature curl -LO https://github.com/getsops/sops/releases/download/v3.9.1/sops-v3.9.1.checksums.txt curl -LO https://github.com/getsops/sops/releases/download/v3.9.1/sops-v3.9.1.checksums.pem curl -LO https://github.com/getsops/sops/releases/download/v3.9.1/sops-v3.9.1.checksums.sig ### Verify the checksums file cosign verify-blob sops-v3.9.1.checksums.txt \ --certificate sops-v3.9.1.checksums.pem \ --signature sops-v3.9.1.checksums.sig \ --certificate-identity-regexp=https://github.com/getsops \ --certificate-oidc-issuer=https://token.actions.githubusercontent.com ``` ##### Verify binary integrity To verify the integrity of the downloaded binary, you can utilize the checksums file after having validated its signature: ```shell ### Verify the binary using the checksums file sha256sum -c sops-v3.9.1.checksums.txt --ignore-missing ``` ##### Verify artifact provenance The [SLSA provenance](https://slsa.dev/provenance/v0.2) of the binaries, packages, and SBOMs can be found within the artifacts associated with this release. It is presented through an [in-toto](https://in-toto.io/) link metadata file named `sops-v3.9.1.intoto.jsonl`. To verify the provenance of an artifact, you can utilize the [`slsa-verifier`](https://github.com/slsa-framework/slsa-verifier#artifacts) tool: ```shell ### Download the metadata file curl -LO https://github.com/getsops/sops/releases/download/v3.9.1/sops-v3.9.1.intoto.jsonl ### Verify the provenance of the artifact slsa-verifier verify-artifact <artifact> \ --provenance-path sops-v3.9.1.intoto.jsonl \ --source-uri github.com/getsops/sops \ --source-tag v3.9.1 ``` #### Container Images The `sops` binaries are also available as container images, based on Debian (slim) and Alpine Linux. The Debian-based container images include any dependencies which may be required to make use of certain key services, such as GnuPG, AWS KMS, Azure Key Vault, and Google Cloud KMS. The Alpine-based container images are smaller in size, but do not include these dependencies. These container images are available for the following architectures: `linux/amd64` and `linux/arm64`. ##### GitHub Container Registry - `ghcr.io/getsops/sops:v3.9.1` - `ghcr.io/getsops/sops:v3.9.1-alpine` ##### Quay.io - `quay.io/getsops/sops:v3.9.1` - `quay.io/getsops/sops:v3.9.1-alpine` ##### Verify container image signature The container images are signed using [Cosign](https://docs.sigstore.dev/cosign/overview/) with GitHub OIDC. To validate the signature of an image, run the following command: ```shell cosign verify ghcr.io/getsops/sops:v3.9.1 \ --certificate-identity-regexp=https://github.com/getsops \ --certificate-oidc-issuer=https://token.actions.githubusercontent.com \ -o text ``` ##### Verify container image provenance The container images include [SLSA provenance](https://slsa.dev/provenance/v0.2) attestations. For more information around the verification of this, please refer to the [`slsa-verifier` documentation](https://github.com/slsa-framework/slsa-verifier#containers). #### Software Bill of Materials The Software Bill of Materials (SBOM) for each binary is accessible within the artifacts enclosed with this release. It is presented as an [SPDX](https://spdx.dev/) JSON file, formatted as `<binary>.spdx.sbom.json`. #### What's Changed - Explicitly mark goreleaser's version, to avoid confusion with the Go version by [@​felixfontein](https://github.com/felixfontein) in getsops/sops#1548 - build(deps): Bump the go group with 8 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1550 - build(deps): Bump github/codeql-action from 3.25.10 to 3.25.11 in the ci group by [@​dependabot](https://github.com/dependabot) in getsops/sops#1551 - Fix the URL used for determining the latest SOPS version by [@​felixfontein](https://github.com/felixfontein) in getsops/sops#1553 - build(deps): Bump the ci group with 4 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1555 - build(deps): Bump the go group with 11 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1554 - build(deps): Bump the go group with 10 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1558 - build(deps): Bump the ci group with 3 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1559 - build(deps): Bump the go group with 5 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1562 - build(deps): Bump the ci group across 1 directory with 5 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1564 - build(deps): Bump the go group with 4 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1565 - build(deps): Bump github/codeql-action from 3.25.13 to 3.25.15 in the ci group by [@​dependabot](https://github.com/dependabot) in getsops/sops#1566 - build(deps): Bump github.com/docker/docker from 27.0.1+incompatible to 27.1.0+incompatible by [@​dependabot](https://github.com/dependabot) in getsops/sops#1568 - build(deps): Bump the go group with 5 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1575 - build(deps): Bump the ci group with 2 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1574 - build(deps): Bump github.com/docker/docker from 27.1.0+incompatible to 27.1.1+incompatible by [@​dependabot](https://github.com/dependabot) in getsops/sops#1581 - build(deps): Bump the ci group with 3 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1584 - Note on the name of the configuration file by [@​ErraticMaker](https://github.com/ErraticMaker) in getsops/sops#1569 - build(deps): Bump the ci group with 2 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1586 - build(deps): Bump the go group across 1 directory with 15 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1589 - build(deps): Bump the ci group with 2 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1590 - build(deps): Bump the go group with 7 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1593 - build(deps): Bump the ci group with 2 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1592 - tests: ignore env var SOPS_AGE_KEY_FILE by [@​duthils](https://github.com/duthils) in getsops/sops#1595 - build(deps): Bump the go group with 12 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1602 - build(deps): Bump github.com/opencontainers/runc from 1.1.13 to 1.1.14 by [@​dependabot](https://github.com/dependabot) in getsops/sops#1603 - updatekeys subcommand: actually use option `--shamir-secret-sharing-threshold` by [@​felixfontein](https://github.com/felixfontein) in getsops/sops#1608 - Added example of having age recipients in .sops.yaml by [@​felixfontein](https://github.com/felixfontein) in getsops/sops#1607 - GitHub Actions linter for Rust formatting by [@​duthils](https://github.com/duthils) in getsops/sops#1604 - github actions: set rust version globally by [@​duthils](https://github.com/duthils) in getsops/sops#1612 - Fix `--config` being ignored by `loadConfig` by [@​lopter](https://github.com/lopter) in getsops/sops#1613 - build(deps): Bump the go group with 4 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1618 - build(deps): Bump github/codeql-action from 3.26.6 to 3.26.7 in the ci group by [@​dependabot](https://github.com/dependabot) in getsops/sops#1619 - unit tests: add coverage for unset by [@​duthils](https://github.com/duthils) in getsops/sops#1617 - sops_test: homogenize use of asserts by [@​duthils](https://github.com/duthils) in getsops/sops#1622 - sops_test: add more tests on errors by [@​duthils](https://github.com/duthils) in getsops/sops#1624 - Add 'check' task to CI that makes sure everything is green by [@​felixfontein](https://github.com/felixfontein) in getsops/sops#1621 - build(deps): Bump the go group with 10 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1629 - build(deps): Bump github/codeql-action from 3.26.7 to 3.26.8 in the ci group by [@​dependabot](https://github.com/dependabot) in getsops/sops#1628 - refactor: specify missing file in error message by [@​t3hmrman](https://github.com/t3hmrman) in getsops/sops#1625 - CI: Build with Go 1.22 and 1.23; update Vault to 1.14 by [@​reneleonhardt](https://github.com/reneleonhardt) in getsops/sops#1531 - Allow edit subcommand to create files by [@​felixfontein](https://github.com/felixfontein) in getsops/sops#1596 - Build release with Go 1.22.x by [@​felixfontein](https://github.com/felixfontein) in getsops/sops#1615 - GHA: fix checkout action version by [@​felixfontein](https://github.com/felixfontein) in getsops/sops#1630 - Do not encrypt if a key group is empty, or there are no key groups by [@​felixfontein](https://github.com/felixfontein) in getsops/sops#1600 - updatekeys subcommand: show changes in shamir_threshold by [@​felixfontein](https://github.com/felixfontein) in getsops/sops#1609 - Dependabot: fix config for Docker, add config for Rust/Cargo by [@​felixfontein](https://github.com/felixfontein) in getsops/sops#1632 - build(deps): Bump the ci group with 2 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1634 - build(deps): Bump the go group with 7 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1635 - Add Cargo.lock for better reproducability of functional tests by [@​felixfontein](https://github.com/felixfontein) in getsops/sops#1637 - build(deps): Bump the go group with 7 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1639 - build(deps): Bump the rust group in /functional-tests with 5 updates by [@​dependabot](https://github.com/dependabot) in getsops/sops#1638 - Update all go deps with 'go get -t -u ./...' by [@​felixfontein](https://github.com/felixfontein) in getsops/sops#1640 - Do not ignore errors when trying to parse a config file by [@​felixfontein](https://github.com/felixfontein) in getsops/sops#1614 - Release 3.9.1 by [@​felixfontein](https://github.com/felixfontein) in getsops/sops#1642 #### New Contributors - [@​ErraticMaker](https://github.com/ErraticMaker) made their first contribution in getsops/sops#1569 - [@​lopter](https://github.com/lopter) made their first contribution in getsops/sops#1613 - [@​t3hmrman](https://github.com/t3hmrman) made their first contribution in getsops/sops#1625 - [@​reneleonhardt](https://github.com/reneleonhardt) made their first contribution in getsops/sops#1531 **Full Changelog**: getsops/sops@v3.9.0...v3.9.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40NDAuNyIsInVwZGF0ZWRJblZlciI6IjM3LjQ0MC43IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJSZW5vdmF0ZSBCb3QiXX0=-->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Making explicit that only files named
.sops.yamlwill be auto-discovered. And alternative names (like.sops.yml) need to be used with the--configflag.Closes #1567