Refactor project build process #445
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
- Switch to semantic versioning (semver) compatible versioning pattern
- filenames (where applicable)
- embedded version metadata
- Generate RPM/DEB packages using nFPM
- "stable" release packages
- "dev" release packages
- provides binaries with `_dev` suffix in order to more easily
test the impact of new releases
- Add version metadata to Windows executables
- Use `github.com/tc-hib/go-winres` and `winres.json` file to apply
version details to Windows executables provided by this project
- update `.gitignore` to exclude Windows syso files
- these files are produced when running go generate as part of the
build process and should not be retained in version control
- Makefile: Compress binaries and use fixed filenames
- Makefile: Refresh recipes to add "standard" set, new package-related
options
- Build dev/stable releases using go-ci Docker image
- Add Dockerfile to provide "builder" image for Makefile-driven
release builds
- copy project/repo content into container at build time
- explicitly changing owner:group to `builduser`
- explicitly create new `builduser` user and group
- this is explicitly used for Docker-based builds
- set `/builds` as the working directory
- set Git `safe.directory` logic at system level
- Add new `.dockerignore` file to exclude unnecessary items from build
image generation
- Update Dependabot configuration to add update monitoring for
`go-ci-oldstable-build` image
- Update/Add Makefile recipes
- add separate docker/podman variants of container-based project
build recipes
- each uses slightly different logic to achieve rootless container
execution
- new recipes
- `docker-release-build`
- `docker-dev-build`
- `docker-packages`
- `podman-release-build`
- `podman-dev-build`
- `podman-packages`
- explicitly emit the tool used to perform specific tasks
- this can be useful to help explain why a generated builder image
does not appear in the `docker image ls` output as a sysadmin
might expect (if it was instead built with the `docker` command)
- rename/remove the helper build recipe from the `help` recipe
output (not useful to call directly)
- to explicitly run the build container as the `builduser` user that
is created during build image generation when using Docker to
build/run containers (Podman uses different settings)
- to send `xz` compressed output to stdout, then redirect to a
target file
- this works around failures to `chmod` and `chgrp` the compressed
copy of input files when run within a non-root container
- to explicitly bind mount the `release_assets` path into
`/builds/release_assets` (using the same Makefile variable)
read/write (instead of relying on implied read/write access)
- to explicitly use `/builds` as the working directory
- Update README
- note decompression step needed after downloading individual
binaries or building via some Makefile recipes
- note DEB and RPM packages as alternatives to downloading
individual binaries
This collection of changes allows reliably building this project using
either Docker or Podman via a "rootless" container.
refs GH-438
refs GH-439
refs GH-440
refs GH-441
refs GH-442
refs GH-443
atc0005
added
documentation
|
Test failure related to #444 , will fix that in a follow-up commit. |
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.
Changes
_devsuffix in order to more easily test the impact of new releasesgithub.com/tc-hib/go-winresandwinres.jsonfile to apply version details to Windows executables provided by this project.gitignoreto exclude Windows syso filesbuilduserbuilduseruser and group/buildsas the working directorysafe.directorylogic at system level.dockerignorefile to exclude unnecessary items from build image generationgo-ci-oldstable-buildimagedocker-release-build-docker-dev-build-docker-packages-podman-release-build-podman-dev-build-podman-packagesdocker image lsoutput as a sysadmin might expect (if it was instead built with thedockercommand)helprecipe output (not useful to call directly)builduseruser that is created during build image generation when using Docker to build/run containers (Podman uses different settings)xzcompressed output to stdout, then redirect to a target filechmodandchgrpthe compressed copy of input files when run within a non-root containerrelease_assetspath into/builds/release_assets(using the same Makefile variable) read/write (instead of relying on implied read/write access)/buildsas the working directoryThis collection of changes allows reliably building this project using either Docker or Podman via a "rootless" container.
References