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

Feature Request: Add Nix Flake for Building Polar Binaries and Running Static Analysis #24

Open
3 of 7 tasks
vonjackets opened this issue Dec 3, 2024 · 0 comments
Open
3 of 7 tasks
Assignees
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@vonjackets
Copy link
Collaborator

vonjackets commented Dec 3, 2024

Description
As a contributor or maintainer, I would like a Nix Flake setup for this repository that not only builds the project but also integrates static analysis checks.
This would ensure consistent builds and automated code quality checks across development environments and CI pipelines.


Proposed Feature
Create a Nix Flake that:

  1. Uses crane or naersk to build the project with necessary dependencies.
  2. Runs static analysis on the Rust source code using the Crane library.
  3. Generate mTLS certificates to ease development tasks

Acceptance Criteria

  • A flake.nix file is added to the repository.
  • The flake defines a package for building the Rust project.
  • The flake defines a derivation for generating certs to support mTLS and ease of development
  • The flake defines containers suitable for development, testing and production use
  • The flake includes a derivation to run Crane static analysis on the source code.
  • Documentation is added to describe how to use the flake for development and analysis.
  • The setup works across Linux platforms.

Additional Context
Static analysis tools like those crane runs can help identify potential issues in the Rust codebase early and enforce best practices. By integrating it into the Nix Flake, developers can run these checks consistently without requiring external setup.


Steps for Implementation

Add a nix flake in agent workspaces that uses crane or naersk to build the project and run static analysis checks, then distributes one or more binaries as a user sees fit.


I'm happy to help draft the initial implementation if needed.

@vonjackets vonjackets added enhancement New feature or request help wanted Extra attention is needed labels Dec 3, 2024
@vonjackets vonjackets self-assigned this Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant