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

factorio: use requireFile with better error msg and split off API docs to devdoc #301816

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

Conversation

muggenhor
Copy link
Contributor

@muggenhor muggenhor commented Apr 5, 2024

Specifically display the actual releaseType and version that they have to fetch manually instead of expecting them to derive this information from the full path of the derivation that just failed to build.

On top of that this splits the developer/API documentation to a separate devdoc output. Allowing most users to save on the ~100 MiB that this occupies. (Note this is basically an offline copy of https://lua-api.factorio.com/latest/ )

Description of changes

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 24.05 Release Notes (or backporting 23.05 and 23.11 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

…ssing

Specifically display the *actual* releaseType and version that they have
to fetch manually instead of expecting them to derive this information
from the full path of the derivation that just failed to build.
@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux labels Apr 5, 2024
@ofborg ofborg bot requested review from priegger, elitak, erictapen, lukegb and Baughn April 6, 2024 00:04
@ofborg ofborg bot added 10.rebuild-linux: 1-10 and removed 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux labels Apr 6, 2024
@muggenhor muggenhor changed the title factorio: display useful help message instead of leaving the user guessing factorio: use requireFile with better error msg and split off API docs to devdoc Apr 8, 2024
@FliegendeWurst FliegendeWurst added the 2.status: merge conflict This PR has merge conflicts with the target branch label Oct 31, 2024
Copy link
Member

Choose a reason for hiding this comment

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

This was moved to pkgs/by-name

@erictapen erictapen removed their request for review October 31, 2024 09:51
@wegank wegank added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.status: merge conflict This PR has merge conflicts with the target branch 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants