Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Standardizes the way we build #87

Merged
merged 4 commits into from
Dec 23, 2021
Merged

Conversation

betterengineering
Copy link
Contributor

Overview

We have several different ways to build this repo currently:

  • The method outlined in the build docs, which is now not working
  • The method in the Makefile
  • The method in the github action file
  • A private method defined internally at Tidbyt 😄

This change standardizes the way we build this repo so there's less confusion around how it's built. Additionally, any changes to the way we build pixlet will work the same way in CI and local development.

Changes

  • Remove font embedding from build.
    • I added this when I was doing a lot of font work, but now that I'm not it really is annoying to generate fonts each time. This commit makes it so the only target for build is a clean.
  • Remove build directory in make.
    • This is unnecessary and I feel bad for adding it. I've removed it so that a build places the binary in the root.
  • Updated build to use make.
    • This commit updates the build to use make so there is one way to build things.
  • Updated build docs.
    • This commit updates the build docs to use the one true way to build this repository.

Tests

mark@dev-mark:~/code/src/tidbyt.dev/pixlet|mark/fix-build-docs ⇒  make build
rm pixlet
go build -o pixlet tidbyt.dev/pixlet
mark@dev-mark:~/code/src/tidbyt.dev/pixlet|mark/fix-build-docs ⇒  ./pixlet
Pixlet renders graphics for pixel devices, like Tidbyt

Usage:
  pixlet [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  push        Pushes a webp image to a Tidbyt device
  render      Runs script with provided config parameters.
  serve       Serves a starlark render script over HTTP.

Flags:
  -h, --help   help for pixlet

Use "pixlet [command] --help" for more information about a command.

I added this when I was doing a lot of font work, but now that I'm not
it really is annoying to generate fonts each time. This commit makes it
so the only target for build is a clean.
This is unncessary and I feel bad for adding it. I've removed it so that
a build places the binary in the root.
This commit updates the build to use make so there is one way to build
things.
This commit updates the build docs to use the one true way to build this
repository.
@betterengineering
Copy link
Contributor Author

Fixes #84

@betterengineering betterengineering merged commit bf47935 into main Dec 23, 2021
@betterengineering betterengineering deleted the mark/fix-build-docs branch December 23, 2021 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants