Skip to content

repo: removed shell.nix and moved to nix flakes #28

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

Merged
merged 4 commits into from
Apr 4, 2025
Merged

repo: removed shell.nix and moved to nix flakes #28

merged 4 commits into from
Apr 4, 2025

Conversation

lromor
Copy link
Owner

@lromor lromor commented Apr 3, 2025

No description provided.

@lromor lromor requested a review from Copilot April 3, 2025 09:53
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR removes the shell.nix file and updates documentation to reflect the migration to Nix flakes. Key changes include:

  • Removal of shell.nix
  • Updated README instructions to use Nix flakes via nix develop
  • Added a note for Nix/NixOS users on enabling flakes
Files not reviewed (3)
  • .bazelignore: Language not supported
  • flake.nix: Language not supported
  • shell.nix: Language not supported
Comments suppressed due to low confidence (1)

README.md:16

  • [nitpick] Consider renaming 'devShell' to 'development shell' for clarity.
> If you are using Nix or NixOS, ensure you have [flakes enabled][enable-flakes] and enter the devShell via `nix develop`.

@lromor lromor requested a review from Copilot April 3, 2025 09:53
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the repository's documentation to reflect the migration from using shell.nix to nix flakes.

  • Removed instructions referencing shell.nix
  • Added guidance for Nix and NixOS users to use nix flakes via a devShell
Files not reviewed (3)
  • .bazelignore: Language not supported
  • flake.nix: Language not supported
  • shell.nix: Language not supported

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR removes the old shell.nix file and updates the documentation to instruct users on how to use Nix flakes instead.

  • Removed references to shell.nix
  • Added a note in the usage section for Nix/NixOS users with instructions to use nix develop
Files not reviewed (3)
  • .bazelignore: Language not supported
  • flake.nix: Language not supported
  • shell.nix: Language not supported

@lromor
Copy link
Owner Author

lromor commented Apr 3, 2025

@hzeller now everything seems to work. I should possible document what this PR has now enabled, such as:

  • Enter a dev environment by simply typing nix develop
  • Run fpga-as via nix run
  • Build the nix package via nix build

What do you think?

description = "fpga-assembler";

inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd probably fix that to a commit or 24.11 so that we don't create a new flake derivation every day nixos-unstable changes.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I studied a bit more flakes, as long as the flake.lock doesn't get updated, the channel is pinned.

"rev": "2c8d3f48d33929642c1c12cd243df4cc7d2ce434",

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer to be explicit.
The lock file is a non-human readable format to be explicit.
So we should put the version in the flake.nix to be human readably explicit.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Upsie! I'll make a commit that adds a specific revision then!

@lromor lromor merged commit a7503ca into main Apr 4, 2025
4 checks passed
@lromor lromor deleted the nix-flake branch April 4, 2025 16:07
@lromor lromor mentioned this pull request Apr 4, 2025
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