brickstore: init at 0-unstable-2024-05-02 #309937

jrobinson-uk · 2024-05-07T20:36:25Z

Description of changes

Created a new package deviation for building the popular offline Lego store inventory tool Brickstore.
First version begins at v2024.5.2, see release notes

Things done

Built on local system and tested through last 2 package releases

I would like to support by reviewing pull requests but would like to see this pull request through to ensure I understand the process

Add a 👍 reaction to pull requests you find important.

DontEatOreo · 2024-05-07T21:40:07Z

Thanks for making a PR! You will need to rebase so you can comply with the Commit Conventions

In your case please squash d49b7d3 7fed93b 9d16a5f into bb280d1 and reword bb280d1 to brickstore: init at 0-unstable-2024-05-02

As well adding yourself as maintainer should be separate commit and in your case should be titled maintainers: add legojames

EDIT: Please move your package to pkgs/by-name (https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/README.md) and reword your PR title to brickstore: init at 0-unstable-2024-05-02

DontEatOreo · 2024-05-08T00:23:50Z

I'm not exactly sure how package this but I think this will set you in the right direction.

{
  lib,
  stdenv,
  qt6,
  libsForQt5,
  fetchFromGitHub,
  gst_all_1,
  cmake,
  libglvnd,
  tbb,
  ninja,
  pkg-config,
}:
let
  inherit (libsForQt5) qcoro;
in
stdenv.mkDerivation (finalAttrs: {
  pname = "brickstore";
  version = "0-unstable-2024-05-02";

  src = fetchFromGitHub {
    owner = "rgriebl";
    repo = finalAttrs.pname;
    rev = "v2024.5.2";
    hash = "sha256-Bu9oNbZm3lx/CfYAReHyWe/kW+kaefDWeBtWLHOCORU=";
    fetchSubmodules = true;
  };

  nativeBuildInputs = [
    cmake
    libglvnd
    ninja
    pkg-config
    qcoro
    qt6.qtdoc
    qt6.qtdeclarative
    qt6.qtimageformats
    qt6.qtmultimedia
    qt6.qtquick3d
    qt6.qtquicktimeline
    qt6.qtshadertools
    qt6.qttools
    qt6.qtwayland
    qt6.wrapQtAppsHook
    tbb
  ];

  preConfigure = ''
    # deletes line https://github.com/rgriebl/brickstore/blob/1e62a8bdf7da848a0033b8647d3711d95a3afd8d/cmake/BuildQCoro.cmake#L21
    # This isn't good but not sure how to do it via substituteInPlace
    sed -i '/^)$/d' cmake/BuildQCoro.cmake

    substituteInPlace cmake/BuildQCoro.cmake \
      --replace-fail 'FetchContent_Declare(' ' ' \
      --replace-fail '    qcoro' ' ' \
      --replace-fail '    GIT_REPOSITORY https://github.com/danvratil/qcoro.git' ' ' \
      --replace-fail '    GIT_TAG        v''${QCORO_VERSION}' ' ' \
      --replace-fail 'FetchContent_GetProperties(qcoro)' ' ' \
      --replace-fail 'FetchContent_Populate(qcoro)' ' ' \
      --replace-fail \
        'add_subdirectory(''${qcoro_SOURCE_DIR} ''${qcoro_BINARY_DIR} EXCLUDE_FROM_ALL)' \
        'add_subdirectory(${qcoro.src} ${qcoro}bin/qcoro)'
  '';

  qtWrapperArgs = [
    ''
      --prefix GST_PLUGIN_SYSTEM_PATH_1_0 : ${
        lib.makeLibraryPath [
          gst_all_1.gstreamer
          gst_all_1.gst-plugins-base
          gst_all_1.gst-plugins-good
          gst_all_1.gst-plugins-bad
          gst_all_1.gst-plugins-ugly
          gst_all_1.gst-libav
        ]
      }
    ''
  ];

  meta = {
    changelog = "https://github.com/rgriebl/brickstore/blob/main/CHANGELOG.md";
    description = "BrickLink offline management tool";
    homepage = "https://www.brickstore.dev/";
    license = lib.licenses.gpl3Plus;
    longDescription = ''
      BrickStore is a BrickLink offline management tool.
      It is multi-platform (Windows, macOS and Linux as well as iOS and Android),
      multilingual (currently English, German, Spanish, Swedish and French), fast and stable.
    '';
    maintainers = with lib.maintainers; [ legojames ];
    platforms = lib.platforms.linux;
  };
})

jrobinson-uk · 2024-05-08T07:47:17Z

I'm not exactly sure how package this but I think this will set you in the right direction.

{
  lib,
  stdenv,
  qt6,
  libsForQt5,
  fetchFromGitHub,
  gst_all_1,
  cmake,
  libglvnd,
  tbb,
  ninja,
  pkg-config,
}:
let
  inherit (libsForQt5) qcoro;
in
stdenv.mkDerivation (finalAttrs: {
  pname = "brickstore";
  version = "0-unstable-2024-05-02";

  src = fetchFromGitHub {
    owner = "rgriebl";
    repo = finalAttrs.pname;
    rev = "v2024.5.2";
    hash = "sha256-Bu9oNbZm3lx/CfYAReHyWe/kW+kaefDWeBtWLHOCORU=";
    fetchSubmodules = true;
  };

  nativeBuildInputs = [
    cmake
    libglvnd
    ninja
    pkg-config
    qcoro
    qt6.qtdoc
    qt6.qtdeclarative
    qt6.qtimageformats
    qt6.qtmultimedia
    qt6.qtquick3d
    qt6.qtquicktimeline
    qt6.qtshadertools
    qt6.qttools
    qt6.qtwayland
    qt6.wrapQtAppsHook
    tbb
  ];

  preConfigure = ''
    # deletes line https://github.com/rgriebl/brickstore/blob/1e62a8bdf7da848a0033b8647d3711d95a3afd8d/cmake/BuildQCoro.cmake#L21
    # This isn't good but not sure how to do it via substituteInPlace
    sed -i '/^)$/d' cmake/BuildQCoro.cmake

    substituteInPlace cmake/BuildQCoro.cmake \
      --replace-fail 'FetchContent_Declare(' ' ' \
      --replace-fail '    qcoro' ' ' \
      --replace-fail '    GIT_REPOSITORY https://github.com/danvratil/qcoro.git' ' ' \
      --replace-fail '    GIT_TAG        v''${QCORO_VERSION}' ' ' \
      --replace-fail 'FetchContent_GetProperties(qcoro)' ' ' \
      --replace-fail 'FetchContent_Populate(qcoro)' ' ' \
      --replace-fail \
        'add_subdirectory(''${qcoro_SOURCE_DIR} ''${qcoro_BINARY_DIR} EXCLUDE_FROM_ALL)' \
        'add_subdirectory(${qcoro.src} ${qcoro}bin/qcoro)'
  '';

  qtWrapperArgs = [
    ''
      --prefix GST_PLUGIN_SYSTEM_PATH_1_0 : ${
        lib.makeLibraryPath [
          gst_all_1.gstreamer
          gst_all_1.gst-plugins-base
          gst_all_1.gst-plugins-good
          gst_all_1.gst-plugins-bad
          gst_all_1.gst-plugins-ugly
          gst_all_1.gst-libav
        ]
      }
    ''
  ];

  meta = {
    changelog = "https://github.com/rgriebl/brickstore/blob/main/CHANGELOG.md";
    description = "BrickLink offline management tool";
    homepage = "https://www.brickstore.dev/";
    license = lib.licenses.gpl3Plus;
    longDescription = ''
      BrickStore is a BrickLink offline management tool.
      It is multi-platform (Windows, macOS and Linux as well as iOS and Android),
      multilingual (currently English, German, Spanish, Swedish and French), fast and stable.
    '';
    maintainers = with lib.maintainers; [ legojames ];
    platforms = lib.platforms.linux;
  };
})

Is this to replace my patch approach? I took that approach as I thought I read something that said that downloading addtional requirements should be done using nixos helper tools like fetchFromGithub

DontEatOreo · 2024-05-08T11:14:18Z

Your older commits had a patch file, but it was just a duplicate of the default.nix file with the .patch extension (As seen in d49b7d3). There was no actual patch in that commit, so I don't know what your original approach was. After looking at the project, I found that only cmake/BuildQCoro.cmake was trying to download something from GitHub and I just got rid of that logic and patch the path for qcoro

I noticed you were downloading qcoro with fetchFromGitHub to patch the source code. This isn't needed as qcoro is already packaged in nixpkgs

I was able to build the package on x86_64-linux and run the GUI program, but I don't know how to use it. So I don't know if everything is working correctly. Please let me know if there are any issues.

jrobinson-uk · 2024-05-08T19:56:47Z

brickstore: init at 0-unstable-2024-05-02

I've never had to rebase before, I've tried git rebase -i master and squashed the relevant commits but it leads to merge conflicts from other parts of nix-pkgs.

Would like to figure it out but would it be easier to close this pull, re-clone my fork and start again?

DontEatOreo · 2024-05-08T20:22:41Z

Would like to figure it out but would it be easier to close this pull, re-clone my fork and start again?

No need, we can solve the issue here! Let me show you how.

You will need to checkout the branch add-brickstore-package. Afterwards, you will need to rebase the last 5 commits by running: git rebase -i HEAD~5. After that, you will have a list of the 5 commits, and you will just need to replace the pick word at the start with the appropriate one:

In your case this is how the rebase file should look like before saving it:

pick 9d16a5fb3c26 Last Sync: 2024-05-07 21:00:42 (Xen)
squash 7fed93b6e68f brickstore: init at 2024.5.2 https://github.com/rgriebl/brickstore/releases/tag/v2024.5.2
squash d49b7d30f35a brickstore: v2024.5.2 Adding no-download patch to ensure qcoro is fetched and built via fetchFromGitHub
squash bb280d1bc875 brickstore: v2024.5.2 Fixing editorconfig issue
squash 796ab14da982 Last Sync: 2024-05-08 09:00:41 (Xen)

This will squash from 796ab14 to 7fed93b into 9d16a5f

After that, you will need to "softly reset" the commit by running git reset --soft HEAD~1. Then you can unstage all files except the maintainers one. After that, you will just make a commit to add yourself to the maintainer list and word it as maintainers: add legojames. Finally, commit the package with the title brickstore: init at 0-unstable-2024-05-02.

jrobinson-uk · 2024-05-09T09:32:19Z

git rebase -i HEAD~5

I get fatal: invalid upstream 'HEAD-5'

DontEatOreo · 2024-05-09T10:08:28Z

That's because you typed - instead of ~

jrobinson-uk · 2024-05-09T12:18:39Z

brickstore: init at 0-unstable-2024-05-02

I'm an idiot.

Think I've done all that and now just need to push changes, which in turn requires a pull. Do I need to merge, rebase or fast-forward.

hint: You have divergent branches and need to specify how to reconcile them.
hint: You can do so by running one of the following commands sometime before
hint: your next pull:
hint: 
hint:   git config pull.rebase false  # merge
hint:   git config pull.rebase true   # rebase
hint:   git config pull.ff only       # fast-forward only

I'm guessing merge?

DontEatOreo · 2024-05-09T13:13:12Z

No worries! Run git reflog. This will open up a log of the git commands you've done. Afterwards, you just need to find which line was the one before the merge conflict and then copy the "HEAD." It will look something like this: HEAD@{X}. After that, you will just need to run git reset --hard HEAD@{X}, which allows you to essentially "go back in time" and redo the rebase again, and then you can force push the changes.

DontEatOreo · 2024-05-09T13:53:28Z

I see you're struggling a bit, but no worries! So make sure to run git reflog and take a close look at which line was the one before all the extra commits, the one where you had your original 5 commits, then just do git reset --hard HEAD@{X} (X being whatever number you need based on your local history) and start the rebase again, you don't need to make any extra commits.

jrobinson-uk · 2024-05-09T13:56:58Z

git reflog

Thanks, I think that's HEAD{742} based on this:

d49b7d30f35a HEAD@{741}: commit: brickstore: v2024.5.2
7fed93b6e68f HEAD@{742}: commit: brickstore: init at 2024.5.2

DontEatOreo · 2024-05-09T14:06:54Z

It's a bit hard for me to tell exactly, but it seems that HEAD@{742} is the one. After resetting to it, take a look at your git log and squash any extra commits into your initial commit. Then "softly reset" the commit, then commit the maintainer file, and then your package, after that make sure to force push your changes.

jrobinson-uk · 2024-05-09T14:29:01Z

brickstore: init at 0-unstable-2024-05-02

I think I've done that now 🤞 , thanks for the help in getting this far

DontEatOreo · 2024-05-09T14:33:12Z

Almost correct! Reset again but carefully rebase, as to not pick up anyone else commits

jrobinson-uk · 2024-05-09T15:51:53Z

Almost correct! Reset again but carefully rebase, as to not pick up anyone else commits

Is that just down to the number of commits in the HEAD~5 bit I thought is was just viewing the last 5, but is it actually "include last 5 commits"?

DontEatOreo · 2024-05-09T15:59:25Z

When I was originally asking you to run that command, there were 5 commits, hence the HEAD~5. The numbering starts from 1, where 1 is the latest commit (as HEAD~1), and as you increment the number, you go further down the commit history

EDIT: You can read further about HEAD on https://git-scm.com/docs/gitglossary#def_HEAD

jrobinson-uk · 2024-05-09T19:58:07Z

When I was originally asking you to run that command, there were 5 commits, hence the HEAD~5. The numbering starts from 1, where 1 is the latest commit (as HEAD~1), and as you increment the number, you go further down the commit history

EDIT: You can read further about HEAD on https://git-scm.com/docs/gitglossary#def_HEAD

Think it's done

DontEatOreo · 2024-05-10T08:11:12Z

https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#commit-conventions

jrobinson-uk · 2024-05-10T09:48:58Z

https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#commit-conventions

Have I missed something?

DontEatOreo · 2024-05-10T09:54:04Z

If you have commits pkg-name: oh, forgot to insert whitespace: squash commits in this case. Use git rebase -i. See Squashing Commits for additional information.

Please rebase and squash the other commits into e28daba

DontEatOreo · 2024-05-10T11:25:23Z

Result of nixpkgs-review pr 309937 run on x86_64-linux 1

1 package built:

brickstore

DontEatOreo · 2024-05-10T11:31:20Z

LGTM, Thank you for sticking with the PR, even though I know it was a bit challenging!

jrobinson-uk · 2024-05-10T13:07:48Z

LGTM, Thank you for sticking with the PR, even though I know it was a bit challenging!

Yay, thanks you so much for the support, I learnt a lot (slowly) and feel more confident about adding packages going forward.

What happens next with this PR, how does this become installable from nixpkgs for other users?

DontEatOreo · 2024-05-10T13:43:20Z

Somebody with commit access has to merge it, so there are a couple of scenarios:

You just wait until someone with commit access finds this PR and decides to merge it.
You can post the PR on https://discourse.nixos.org/t/prs-already-reviewed/2617 and again wait for some with commit access to merge it.

For future PR's that haven't been reviewed yet, you can ask on https://discourse.nixos.org/t/prs-ready-for-review/3032 or if you have Matrix account you can ask here too: https://app.element.io/#/room/#review-requests:nixos.org ¹

I added a backport label, which will automatically create a backport PR that will "back port" the program to nixpkgs unstable. You can track the progress here: https://nixpk.gs/pr-tracker.html?pr=309937

When it gets merged into master, you can skip waiting for the backport to be merged, by temporarily installing the package with nix profile install github:NixOS/nixpkgs/master#brickstore² and after it arrives in the channel (or inputs if you use flakes), you can remove it from the profile.

And final note to save time and effort for both yourself and reviewers, please take a careful look again at CONTRIBUTING.md so there is less back and forth, and future PR can get merged faster!

Wishing you luck for any future PRs!

If it takes too long for it to be merged, you can also post in the review requests channels as well. ↩
You will need to have the new nix3 commands enabled for this, though:
https://nixos.org/manual/nix/stable/contributing/experimental-features.html?highlight=experimental-features
https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-profile ↩

drupol

Hi,

Thanks for your PR. I've left some comments, let me know if this is clear enough.

drupol · 2024-05-13T12:19:39Z

pkgs/by-name/br/brickstore/package.nix

+    ''
+  ];
+
+  meta = {


Missing meta.mainProgram

drupol · 2024-05-13T12:20:00Z

pkgs/by-name/br/brickstore/package.nix

+
+  src = fetchFromGitHub {
+    owner = "rgriebl";
+    repo = finalAttrs.pname;


Please don't use this.

repo = pname; is nice for DRY but creates a binding that goes too far.

See further information about this here: nix-community/nixpkgs-lint#21

drupol · 2024-06-06T20:44:45Z

Please rebase your branch on top of the latest commit from master and it's good for me.

drupol · 2024-06-06T21:17:09Z

Nope... this PR shouldn't contain any merge commit.

DontEatOreo

LGTM!

In the future, when you have merge conflict on a PR, you can checkout master then pull with a rebase (make sure to update your fork master first) and then do a git rebase on your local branch.

git checkout master
# you can add `origin master` to be very explicit
git pull --rebase
git checkout add-bricktore-package
git rebase master

Then resolve any conflict

pkgs/by-name/br/brickstore/package.nix

Removing redundant comments

github-actions · 2024-06-07T13:27:33Z

Successfully created backport PR for release-24.05:

[Backport release-24.05] brickstore: init at 0-unstable-2024-05-02 #318006

github-actions bot added the 8.has: maintainer-list (update) label May 7, 2024

ofborg bot added 10.rebuild-darwin: 0 10.rebuild-linux: 0 labels May 7, 2024

ofborg bot added 8.has: package (new) 11.by: package-maintainer 10.rebuild-linux: 1-10 10.rebuild-linux: 1 and removed 10.rebuild-linux: 0 labels May 9, 2024

jrobinson-uk force-pushed the add-bricktore-package branch from f8ef014 to 1750925 Compare May 9, 2024 14:27

github-actions bot added the 6.topic: python label May 9, 2024

github-actions bot removed the 6.topic: python label May 9, 2024

jrobinson-uk force-pushed the add-bricktore-package branch from 1a44082 to 4749c45 Compare May 9, 2024 19:22

jrobinson-uk changed the title ~~Add bricktore package~~ brickstore: init at 0-unstable-2024-05-02 May 10, 2024

jrobinson-uk force-pushed the add-bricktore-package branch from 1f57e72 to f4de587 Compare May 10, 2024 10:23

DontEatOreo approved these changes May 10, 2024

View reviewed changes

DontEatOreo added the backport release-23.11 Backport PR automatically label May 10, 2024

wegank added the 12.approvals: 1 label May 11, 2024

DontEatOreo requested a review from drupol May 13, 2024 10:47

drupol requested changes May 13, 2024

View reviewed changes

DontEatOreo added backport release-24.05 Backport PR automatically and removed backport release-23.11 Backport PR automatically labels Jun 1, 2024

drupol approved these changes Jun 6, 2024

View reviewed changes

maintainers: add legojames

e70c4f3

jrobinson-uk force-pushed the add-bricktore-package branch from d150899 to b4e7509 Compare June 6, 2024 21:19

DontEatOreo approved these changes Jun 6, 2024

View reviewed changes

drupol requested changes Jun 6, 2024

View reviewed changes

pkgs/by-name/br/brickstore/package.nix Outdated Show resolved Hide resolved

DontEatOreo reviewed Jun 6, 2024

View reviewed changes

pkgs/by-name/br/brickstore/package.nix Outdated Show resolved Hide resolved

brickstore: init at 0-unstable-2024-05-02

7361668

Removing redundant comments

jrobinson-uk force-pushed the add-bricktore-package branch from b4e7509 to 7361668 Compare June 7, 2024 11:38

drupol approved these changes Jun 7, 2024

View reviewed changes

drupol merged commit de98620 into NixOS:master Jun 7, 2024
23 of 25 checks passed

github-actions bot mentioned this pull request Jun 7, 2024

[Backport release-24.05] brickstore: init at 0-unstable-2024-05-02 #318006

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

brickstore: init at 0-unstable-2024-05-02 #309937

brickstore: init at 0-unstable-2024-05-02 #309937

jrobinson-uk commented May 7, 2024

DontEatOreo commented May 7, 2024 •

edited

DontEatOreo commented May 8, 2024

jrobinson-uk commented May 8, 2024

DontEatOreo commented May 8, 2024

jrobinson-uk commented May 8, 2024

DontEatOreo commented May 8, 2024

jrobinson-uk commented May 9, 2024

DontEatOreo commented May 9, 2024

jrobinson-uk commented May 9, 2024 •

edited

DontEatOreo commented May 9, 2024

DontEatOreo commented May 9, 2024

jrobinson-uk commented May 9, 2024

DontEatOreo commented May 9, 2024

jrobinson-uk commented May 9, 2024

DontEatOreo commented May 9, 2024

jrobinson-uk commented May 9, 2024

DontEatOreo commented May 9, 2024 •

edited

jrobinson-uk commented May 9, 2024

DontEatOreo commented May 10, 2024

jrobinson-uk commented May 10, 2024

DontEatOreo commented May 10, 2024

DontEatOreo commented May 10, 2024

DontEatOreo commented May 10, 2024

jrobinson-uk commented May 10, 2024

DontEatOreo commented May 10, 2024

drupol left a comment

drupol May 13, 2024

drupol May 13, 2024

drupol commented Jun 6, 2024

drupol commented Jun 6, 2024

DontEatOreo left a comment •

edited

github-actions bot commented Jun 7, 2024

brickstore: init at 0-unstable-2024-05-02 #309937

brickstore: init at 0-unstable-2024-05-02 #309937

Conversation

jrobinson-uk commented May 7, 2024

Description of changes

Things done

I would like to support by reviewing pull requests but would like to see this pull request through to ensure I understand the process

DontEatOreo commented May 7, 2024 • edited

DontEatOreo commented May 8, 2024

jrobinson-uk commented May 8, 2024

DontEatOreo commented May 8, 2024

jrobinson-uk commented May 8, 2024

DontEatOreo commented May 8, 2024

jrobinson-uk commented May 9, 2024

DontEatOreo commented May 9, 2024

jrobinson-uk commented May 9, 2024 • edited

DontEatOreo commented May 9, 2024

DontEatOreo commented May 9, 2024

jrobinson-uk commented May 9, 2024

DontEatOreo commented May 9, 2024

jrobinson-uk commented May 9, 2024

DontEatOreo commented May 9, 2024

jrobinson-uk commented May 9, 2024

DontEatOreo commented May 9, 2024 • edited

jrobinson-uk commented May 9, 2024

DontEatOreo commented May 10, 2024

jrobinson-uk commented May 10, 2024

DontEatOreo commented May 10, 2024

DontEatOreo commented May 10, 2024

DontEatOreo commented May 10, 2024

jrobinson-uk commented May 10, 2024

DontEatOreo commented May 10, 2024

Wishing you luck for any future PRs!

Footnotes

drupol left a comment

Choose a reason for hiding this comment

drupol May 13, 2024

Choose a reason for hiding this comment

drupol May 13, 2024

Choose a reason for hiding this comment

drupol commented Jun 6, 2024

drupol commented Jun 6, 2024

DontEatOreo left a comment • edited

Choose a reason for hiding this comment

github-actions bot commented Jun 7, 2024

DontEatOreo commented May 7, 2024 •

edited

jrobinson-uk commented May 9, 2024 •

edited

DontEatOreo commented May 9, 2024 •

edited

DontEatOreo left a comment •

edited