grafana/README.md

grafana

The grafana package

Setup instructions

• clone the upstream sources: git clone https://github.com/grafana/grafana && cd grafana
• checkout the version of the specfile: git checkout <currentversion>
• apply existing patches: git am ../0*.patch

Upgrade instructions

• follow the Setup instructions above
• rebase to the new version: git fetch && git rebase --onto <newversion> <oldversion>
  • rebasing remove-unused-backend-dependencies.patch: only apply the patch to pkg/extensions/main.go and run go mod tidy, then go.mod and go.sum will get updated automatically
  • rebasing remove-unused-frontend-crypto.patch: only apply the patch to package.json and run yarn install, then yarn.lock will get updated automatically
• create new patches from the modified git commits: git format-patch -N --no-stat --no-signature <newversion> && mv *.patch ..
• update Version, Release, %changelog and tarball NVRs in the specfile
• create bundles and manifest: ./create_bundles_in_container.sh
• inspect the vendor tarball for any new non-FIPS crypto (vendor/golang.org/x/crypto), delete these files/directories in the Makefile and update the patch-removed-backend-crypto.patch if required
• update specfile with contents of the .manifest file
• update the manpages patch in 0002-add-manpages.patch and other patches if required
• run local build: rpkg local
• run rpmlint: rpmlint -r grafana.rpmlintrc /tmp/rpkg/grafana-*/grafana-*.src.rpm /tmp/rpkg/grafana-*/x86_64/grafana-*.x86_64.rpm
• run a scratch build: fedpkg scratch-build --srpm
• upload new source tarballs: fedpkg new-sources *.tar.gz *.tar.xz
• commit new sources file

Patches

• create the patch
• declare and apply (%prep) the patch in the specfile
• if the patch affects Go or Node.js dependencies, or the webpack
  • update the create_bundles.sh script and apply the patch
  • create new tarballs
  • update the specfile with new tarball name and contents of the .manifest file

General guidelines

• aim to apply all patches in the specfile
• avoid rebuilding the tarballs

Patches fall in several categories:

• modify dependency versions
• modify both sources and vendored dependencies (e.g. CVEs)
• modify the Node.js source (i.e. affect the webpack)
• some patches are conditional (e.g. FIPS)

Patches cannot be applied twice. It is not possible to unconditionally apply all patches in the Makefile, and great care must be taken to include the required patches at the correct stage of the build.

Reproducible Bundles

Run ./create_bundles_in_container.sh to generate a reproducible vendor and webpack bundle.

Verification

• compare the list of files with the upstream RPM at https://grafana.com/grafana/download