butane: import as git subtree (alternative to #2235)

Makefile

@@ -28,6 +28,7 @@ install: all
 	install -m 0644 -D -t $(DESTDIR)/usr/lib/systemd/system systemd/ignition-delete-config.service
 	install -m 0755 -D -t $(DESTDIR)/usr/lib/dracut/modules.d/30ignition bin/$(GOARCH)/ignition
 	install -m 0755 -D -t $(DESTDIR)/usr/bin bin/$(GOARCH)/ignition-validate
+	install -m 0755 -D -t $(DESTDIR)/usr/bin bin/$(GOARCH)/butane
 	install -m 0755 -d $(DESTDIR)/usr/libexec
 	ln -sf ../lib/dracut/modules.d/30ignition/ignition $(DESTDIR)/usr/libexec/ignition-apply
 	ln -sf ../lib/dracut/modules.d/30ignition/ignition $(DESTDIR)/usr/libexec/ignition-rmcfg

build

@@ -35,3 +35,7 @@ NAME="ignition-validate"
 
 echo "Building ${NAME}..."
 go build -ldflags "${GLDFLAGS}" -o ${BIN_PATH}/${NAME} ${REPO_PATH}/validate
+
+# Build butane from the subtree (separate Go module)
+echo "Building butane..."
+(cd butane && BIN_PATH=${BIN_PATH} ./build)

butane/.copr/Makefile

@@ -0,0 +1,16 @@
+# Maintained in https://github.com/coreos/repo-templates
+# Do not edit downstream.
+
+.PHONY: srpm
+srpm:
+	dnf install -y git rpm-build rpmdevtools 
+	# similar to https://github.com/actions/checkout/issues/760, but for COPR
+	git config --global --add safe.directory '*'
+	curl -LOf https://src.fedoraproject.org/rpms/butane/raw/rawhide/f/butane.spec
+	version=$$(git describe --always --tags | sed -e 's,-,\.,g' -e 's,^v,,'); \
+	git archive --format=tar --prefix=butane-$$version/ HEAD | gzip > butane-$$version.tar.gz; \
+	sed -ie "s,^Version:.*,Version: $$version," butane.spec
+	sed -ie 's/^Patch/# Patch/g' butane.spec  # we don't want any downstream patches
+	spectool -g butane.spec  # download any remaining sources (e.g. coreos-installer-dracut)
+	rpmbuild -bs --define "_sourcedir ${PWD}" --define "_specdir ${PWD}" --define "_builddir ${PWD}" --define "_srcrpmdir ${PWD}" --define "_rpmdir ${PWD}" --define "_buildrootdir ${PWD}/.build" butane.spec
+	mv *.src.rpm $$outdir

butane/.fmf/version

@@ -0,0 +1 @@
+1

butane/.gemini/config.yaml

@@ -0,0 +1,13 @@
+# This config mainly overrides `summary: false` by default
+# as it's really noisy.
+have_fun: true
+code_review:
+  disable: false
+  comment_severity_threshold: "MEDIUM"
+  max_review_comments: -1
+  pull_request_opened:
+    help: false
+    # Turned off by default
+    summary: false
+    code_review: true
+ignore_patterns: []

butane/.gitattributes

@@ -0,0 +1 @@
+*.go text eol=lf

butane/.github/ISSUE_TEMPLATE/release-checklist.md

@@ -0,0 +1,88 @@
+---
+name: release checklist
+about: release checklist template
+title: New release for butane
+labels: jira,kind/release
+warning: |
+    ⚠️ Template generated by https://github.com/coreos/repo-templates; do not edit downstream
+---
+
+Release checklist:
+
+Tagging:
+ - [ ] Write release notes in `docs/release-notes.md`. Get them reviewed and merged
+   - [ ] If the release signing key has changed because a new Fedora release has gone stable, note the change as done [here](https://github.com/coreos/butane/releases/tag/v0.12.0).
+   - [ ] If doing a branched release, also include a PR to merge the `docs/release-notes.md` changes into main
+ - [ ] Ensure your local copy is up to date with the upstream main branch (`git@github.com:coreos/butane.git`)
+ - [ ] Ensure your working directory is clean (`git clean -fdx`)
+ - [ ] Ensure you can sign commits and any yubikeys/smartcards are plugged in
+ - [ ] Run `./tag_release.sh <vX.Y.z> <git commit hash>`
+ - [ ] Push that tag to GitHub
+
+Fedora packaging:
+ - [ ] Update the spec file in [Fedora](https://src.fedoraproject.org/rpms/butane):
+   - Bump the `Version`
+   - Switch the `Release` back to `1%{?dist}`
+   - Remove any patches obsoleted by the new release
+   - Run `go-mods-to-bundled-provides.py | sort` while inside of the `butane` directory you ran `./tag_release` from & copy output into spec file in `# Main package provides` section
+   - Update changelog
+ - [ ] Run `spectool -g -S butane.spec`
+ - [ ] Run `kinit your_fas_account@FEDORAPROJECT.ORG`
+ - [ ] Run `fedpkg new-sources $(spectool -S butane.spec | sed 's:.*/::')`
+ - [ ] PR the changes in [Fedora](https://src.fedoraproject.org/rpms/butane)
+ - [ ] Once the PR merges to rawhide, merge rawhide into the other relevant branches (e.g. f44) then push those, for example:
+   ```bash
+   git checkout rawhide
+   git pull --ff-only
+   git checkout f44
+   git merge --ff-only rawhide
+   git push origin f44
+   ```
+ - [ ] On each of those branches run `fedpkg build` including rawhide.
+ - [ ] Once the builds have finished, submit them to [bodhi](https://bodhi.fedoraproject.org/updates/new), filling in:
+   - `butane` for `Packages`
+   - Selecting the build(s) that just completed, except for the rawhide one (which gets submitted automatically)
+   - Writing brief release notes like "New upstream release; see release notes at `link to docs/release-notes.md on GH tag`"
+   - Leave `Update name` blank
+   - `Type`, `Severity` and `Suggestion` can be left as `unspecified` unless it is a security release. In that case select `security` with the appropriate severity.
+   - `Stable karma` and `Unstable` karma can be set to `2` and `-1`, respectively.
+
+GitHub release:
+ - [ ] Wait until the Bodhi update shows "Signed :heavy_check_mark:" in the Metadata box.
+ - [ ] Verify that the signing script can fetch the release binaries by running `./signing-ticket.sh test <x.y.z-r> <output-dir>`, where `r` is the Release of the Fedora package without the dist tag (probably `1`)
+ - [ ] Run `./signing-ticket.sh ticket <x.y.z-r>` and paste the output into a [releng ticket](https://forge.fedoraproject.org/releng/tickets/issues/new).
+ - [ ] Wait for the ticket to be closed
+ - [ ] Download the artifacts and signatures
+ - [ ] Verify the signatures
+ - [ ] Find the new tag in the [GitHub tag list](https://github.com/coreos/butane/tags) and click the triple dots menu, and create a draft release for it.
+ - [ ] Copy and paste the release notes from `docs/release-notes.md`
+ - [ ] Upload all the release artifacts and their signatures
+ - [ ] Publish the release
+
+Quay release:
+ - [ ] Visit the [Quay tags page](https://quay.io/repository/coreos/butane?tab=tags) and wait for a versioned tag to appear
+ - [ ] Click the gear next to the tag, select "Add New Tag", enter `release`, and confirm
+ - [ ] Visit the [Quay tags page](https://quay.io/repository/coreos/fcct?tab=tags) for the legacy `coreos/fcct` repo and wait for a versioned tag to appear
+ - [ ] Click the gear next to the tag, select "Add New Tag", enter `release`, and confirm
+
+RHCOS packaging for the current RHCOS development release:
+ - [ ] Update the [spec file](https://gitlab.com/redhat/rhel/rpms/butane)
+   - Bump the `Version`
+   - Switch the `Release` back to `1%{?dist}`
+   - Remove any patches obsoleted by the new release
+   - Run `go-mods-to-bundled-provides.py | sort` while inside of the `butane` directory you ran `./tag_release` from & copy output into spec file in `# Main package provides` section
+   - Update changelog
+ - [ ] Run `spectool -g -S butane.spec`
+ - [ ] Run `kinit your_account@IPA.REDHAT.COM`
+ - [ ] Run `rhpkg new-sources $(spectool -S butane.spec | sed 's:.*/::')`
+ - [ ] PR the changes
+ - [ ] Get the PR reviewed and merge it
+ - [ ] Update your local repo and run `rhpkg build`
+ - [ ] File ticket similar to [this one](https://issues.redhat.com/browse/ART-3711) to sync the new version to mirror.openshift.com
+ - [ ] Wait until mirror.openshift.com is updated and confirm the new version is correct
+
+CentOS Stream 9 packaging:
+  - [ ] Create a `rebase-c9s-butane` issue in the internal team-operations repo and follow the steps there
+
+CentOS Stream 10 packaging:
+  - [ ] Create a `rebase-c10s-butane` issue in the internal team-operations repo and follow the steps there

butane/.github/ISSUE_TEMPLATE/stabilize-checklist.md

@@ -0,0 +1,43 @@
+---
+name: Stabilization checklist
+about: Stabilization checklist template
+title: New stabilization for Butane
+labels: jira
+---
+
+# Bumping spec versions
+
+This checklist describes bumping the Ignition spec version, `base` version, and distro versions. If your scenario is different, modify to taste.
+
+## Stabilize Ignition spec version
+
+- [ ] Bump `go.mod` for new Ignition release and update vendor.
+- [ ] Update imports. Drop `-experimental` from Ignition spec versions in `*/translate_test.go`.
+
+## Bump base version
+
+- [ ] Rename `base/vB_exp` to `base/vB` and update `package` statements. Update imports.
+- [ ] Copy `base/vB` to `base/vB+1_exp`.
+- [ ] Update `package` statements in `base/vB+1_exp`.
+
+## Bump distro version
+
+- [ ] Rename `config/distro/vD_exp` to `config/distro/vD` and update `package` statements. Update imports.
+- [ ] Drop `-experimental` from `init()` in `config/config.go`.
+- [ ] Drop `-experimental` from examples in `docs/`.
+- [ ] Copy `config/distro/vD` to `config/distro/vD+1_exp`.
+- [ ] Update `package` statements in `config/distro/vD+1_exp`. Bump its base dependency to `base/vB+1_exp`.
+- [ ] Import `config/vD+1_exp` in `config/config.go` and add `distro` `C+1-experimental` to `init()`.
+
+## Bump Ignition spec version
+
+- [ ] Bump Ignition types imports and rename `ToIgnI` and `TestToIgnI` functions in `base/vB+1_exp`. Bump Ignition spec versions in `base/vB+1_exp/translate_test.go`.
+- [ ] Bump Ignition types imports in `config/distro/vD+1_exp`. Update `ToIgnI` function names, `util` calls, and header comments to `ToIgnI+1`.
+
+## Update docs
+
+- [ ] Update `internal/doc/main.go` to add the new stable spec and reference the new experimental spec in `generate()`.
+- [ ] Run `generate` to regenerate spec docs.
+- [ ] Update `docs/specs.md`.
+- [ ] Update `docs/upgrading-*.md` for the new spec version. Copy the relevant section from Ignition's `doc/migrating-configs.md`, convert the configs to Butane configs, convert field names to snake case, and update wording as needed. Add subsections for any new Butane-specific features.
+- [ ] Note the stabilization in `docs/release-notes.md`, following the format of previous stabilizations. Drop the `-exp` version suffix from any notes for the upcoming release.

butane/.github/dependabot.yml

@@ -0,0 +1,22 @@
+# Maintained in https://github.com/coreos/repo-templates
+# Do not edit downstream.
+
+# Updates are grouped together by ecosystem in a single PR. An update can be
+# removed from a combined update PR via comments to dependabot:
+# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates#managing-dependabot-pull-requests-for-grouped-updates-with-comment-commands
+
+version: 2
+updates:
+  - package-ecosystem: gomod
+    directory: /
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 10
+    labels:
+      - dependency
+      - skip-notes
+
+    groups:
+      build:
+        patterns:
+          - "*"

butane/.github/workflows/container-rebuild.yml

@@ -0,0 +1,46 @@
+# Maintained in https://github.com/coreos/repo-templates
+# Do not edit downstream.
+
+name: Rebuild release container
+
+on:
+  workflow_dispatch:
+    inputs:
+      git-tag:
+        description: Existing Git tag
+        default: vX.Y.Z
+      docker-tag:
+        description: New Docker versioned tag
+        default: vX.Y.Z-1
+
+permissions:
+  contents: read
+
+# avoid races when pushing containers built from main
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  build-container:
+    name: Build container image
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+        with:
+          ref: ${{ github.event.inputs.git-tag }}
+          # fetch tags so the compiled-in version number is useful
+          fetch-depth: 0
+      # If we're running on a signed tag, actions/checkout rewrites it into
+      # a lightweight tag (!!!) which "git describe" then ignores.  Rewrite
+      # it back.
+      # https://github.com/actions/checkout/issues/290
+      - name: Fix actions/checkout synthetic tag
+        run: git fetch --tags --force
+      - name: Build and push container
+        uses: coreos/actions-lib/build-container@main
+        with:
+          credentials: ${{ secrets.QUAY_AUTH }}
+          push: quay.io/coreos/butane quay.io/coreos/fcct
+          arches: amd64 arm64
+          tags: ${{ github.event.inputs.docker-tag }} release

butane/.github/workflows/container.yml

@@ -0,0 +1,43 @@
+# Maintained in https://github.com/coreos/repo-templates
+# Do not edit downstream.
+
+name: Container
+
+on:
+  push:
+    branches: [main]
+    tags: ["v*"]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+# avoid races when pushing containers built from main
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  build-container:
+    name: Build container image
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+        with:
+          # fetch tags so the compiled-in version number is useful
+          fetch-depth: 0
+      # If we're running on a signed tag, actions/checkout rewrites it into
+      # a lightweight tag (!!!) which "git describe" then ignores.  Rewrite
+      # it back.
+      # https://github.com/actions/checkout/issues/290
+      - name: Fix actions/checkout synthetic tag
+        run: git fetch --tags --force
+      - name: Build and push container
+        uses: coreos/actions-lib/build-container@main
+        with:
+          credentials: ${{ secrets.QUAY_AUTH }}
+          push: quay.io/coreos/butane quay.io/coreos/fcct
+          arches: amd64 arm64
+          # Speed up PR CI by skipping non-amd64
+          pr-arches: amd64

butane/.github/workflows/go.yml

@@ -0,0 +1,83 @@
+# Maintained in https://github.com/coreos/repo-templates
+# Do not edit downstream.
+
+name: Go
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+permissions:
+  contents: read
+
+# don't waste job slots on superseded code
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: Test
+    strategy:
+      matrix:
+        go-version: [1.25.x, 1.26.x]
+        os: [ubuntu-latest]
+        include:
+          - go-version: 1.26.x
+            os: macos-latest
+          - go-version: 1.26.x
+            os: windows-latest
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Set up Go 1.x
+      uses: actions/setup-go@v5
+      with:
+        go-version: ${{ matrix.go-version }}
+    - name: Check out repository
+      uses: actions/checkout@v6
+    - name: Install macOS dependencies
+      if: runner.os == 'macOS'
+      shell: bash
+      run: brew install coreutils
+    - name: Check modules
+      run: go mod verify
+    - name: Test
+      shell: bash
+      run: ./test
+    - name: Check Go formatting (gofmt)
+      if: runner.os == 'Linux'
+      shell: bash
+      run: |
+        GO_FILES=$(find . -name '*.go' -not -path "./vendor/*")
+        UNFORMATTED_FILES=$(gofmt -l $GO_FILES)
+        if [ -n "$UNFORMATTED_FILES" ]; then
+          echo "Go files are not formatted. Please run 'gofmt -w .' on your code."
+          gofmt -d $UNFORMATTED_FILES
+          exit 1
+        fi
+        echo "All Go files are correctly formatted."
+    - name: Run linter
+      uses: golangci/golangci-lint-action@v8
+      if: runner.os == 'Linux'
+      with:
+        version: v2.11.3
+  regenerate:
+    name: Regenerate
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out repository
+      uses: actions/checkout@v6
+    - name: Set up Go 1.x
+      uses: actions/setup-go@v5
+      with:
+        go-version: 1.26.x
+    - name: Regenerate
+      run: ./generate
+    - name: Check whether generated output is current
+      run: |
+        if [ -n "$(git status --porcelain docs)" ]; then
+          echo "Found local changes after regenerating:"
+          git --no-pager diff --color=always docs
+          echo "Rerun './generate'."
+          exit 1
+        fi