auto-commit icon indicating copy to clipboard operation
auto-commit copied to clipboard

Common installation expectations

Open wallentx opened this issue 2 years ago • 0 comments

Hi! Thanks for this cool project.

I discovered, and installed this tool from the AUR, and after installation, I couldn't identify what files had been installed as a result. Files installed via pacman, or from the AUR via a helper are typically discoverable by running pacman -Qql auto-commit, where you'd see the path of the new binary/lib/service/doc as a result of the installation, but that query returned nothing after installing auto-commit.

I looked at the PKGBUILD and saw that it was executing install.sh during the package() step. This works fine, but results in some unexpected behavior:

  • New files added to the system are not known to pacman, so the user cannot query them, nor can the files be removed during an uninstall
  • The install.sh script suggests placing the executable binary in ~/.bin, which is not a standard directory (though maybe common? I've always used a ~/bin, and haven't seen ~/.bin used before) installing them)
  • Running makepkg on the PKGBUILD file locally results in a failure, as it appears to contain some errors
  • Installing this from the AUR resulted in a pre-compiled binary being installed, which wasn't what I was expecting (though you could say that I should probably be reviewing every PKGBUILD before

I normally expect the AUR package name to inform me as to what will be executed:

  • <pkg-name>: I'll be building a tarball of the latest release
  • <pkg-name>-git: I'll be building from the HEAD of the main branch
  • <pkg-name>-bin: I'll be pulling a pre-built binary from the latest release
  • <pkg-name>-bin-git/<pkg-name>-nightly(-bin): I'll be pulling a pre-built binary from some build process that happens more frequently than tagged releases (pre-release/dev/nightly)

I'm not at all suggesting that any of those things are hard rules or anything, but rather I just wanted to open the conversation. I created a draft PR that contains some possible configurations to see if you felt there was a particular one that you might favor, or all if you'd like. https://github.com/m1guelpf/auto-commit/pull/10 I didn't do any workflow modification since this was more of an exploratory effort.

wallentx avatar Nov 19 '22 11:11 wallentx