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

chore: Makefile updates #1325

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

kamilprz
Copy link
Contributor

@kamilprz kamilprz commented Feb 7, 2025

Description

This PR attempts to clean some things up and make developer life smoother.

Adds artifacts to .gitignore to avoid 5k+ files being added after running make quick-build - screenshot below.

Tidies up the Makefile by dividing it into sections, and update comment descriptions to properly appear when running make help.

Adds the following Makefile targets:

  • docs-prod-serve: ## Serve a production build of the docs on localhost:3000
  • retina-cli: ## Build the Retina CLI
  • pretty: ## Run gofumpt, vet and lint
    • I created this as a "one stop shop" that I can run before committing code to make sure that its formatted as the tools expect and doesn't break linting issues. In order to always execute all three tools, I explicitly ignore errors here.

Related Issue

n/a - this was adhoc work, I didn't create an issue for it

Checklist

  • I have read the contributing documentation.
  • I signed and signed-off the commits (git commit -S -s ...). See this documentation on signing commits.
  • I have correctly attributed the author(s) of the code.
  • I have tested the changes locally.
  • I have followed the project's style guidelines.
  • I have updated the documentation, if necessary.
  • I have added tests, if applicable.

Screenshots

{E6CEAA35-E8E6-4A19-9A64-B846E3A6A4AB}

make help (doesn't entirely fit in screenshot)
{AB7EAAC3-F89C-4819-ACE8-BF35B57F4082}

make pretty
{D0467E62-F47A-4638-A723-DCC357EB76EB}


Please refer to the CONTRIBUTING.md file for more information on how to contribute to this project.

@kamilprz kamilprz requested a review from a team as a code owner February 7, 2025 17:43
@kamilprz
Copy link
Contributor Author

kamilprz commented Feb 7, 2025

Seems I might have screwed up some targets in the process - couple checks failed, will look into it

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.

1 participant