Jump to content

Software repository

From Wikipedia, the free encyclopedia
See also: Repository (version control)

A software repository, or repo for short, is a storage location for software packages. Often a table of contents is also stored, along with metadata. A software repository is typically managed by source or version control, or repository managers. Package managers allow automatically installing and updating repositories, sometimes called "packages".

Overview[edit]

Many software publishers and other organizations maintain servers on the Internet for this purpose, either free of charge or for a subscription fee. Repositories may be solely for particular programs, such as CPAN for the Perl programming language, or for an entire operating system. Operators of such repositories typically provide a package management system, tools intended to search for, install and otherwise manipulate software packages from the repositories. For example, many Linux distributions use Advanced Packaging Tool (APT), commonly found in Debian based distributions, or Yellowdog Updater, Modified (yum) found in Red Hat based distributions. There are also multiple independent package management systems, such as pacman, used in Arch Linux and equo, found in Sabayon Linux.

Example of a signed repository key (with ZYpp on openSUSE)

As software repositories are designed to include useful packages, major repositories are designed to be malware free. If a computer is configured to use a digitally signed repository from a reputable vendor, and is coupled with an appropriate permissions system, this significantly reduces the threat of malware to these systems. As a side effect, many systems that have these abilities do not need anti-malware software such as antivirus software.[1]

Most major Linux distributions have many repositories around the world that mirror the main repository.

In an enterprise environment, a software repository is usually used to store artifacts, or to mirror external repositories which may be inaccessible due to security restrictions. Such repositories may provide additional functionality, like access control, versioning, security checks for uploaded software, cluster functionality etc. and typically support a variety of formats in one package, so as to cater for all the needs in an enterprise, and thus aiming to provide a single point of truth. Popular examples are JFrog Artifactory,[2][3] Nexus repository[4] and Cloudsmith,[5] a cloud-based product.

At client side, a package manager helps installing from and updating the repositories.

At server side, a software repository is typically managed by source control or repository managers. Some of the repository managers allow to aggregate other repository location into one URL and provide a caching proxy. When doing continuous builds many artifacts are produced and often centrally stored, so automatically deleting the ones which are not released is important.

Package management system vs. package development process[edit]

A package management system is different from a package development process.

A typical use of a package management system is to facilitate the integration of code from possibly different sources into a coherent stand-alone operating unit. Thus, a package management system might be used to produce a distribution of Linux, possibly a distribution tailored to a specific restricted application.

A package development process, by contrast, is used to manage the co-development of code and documentation of a collection of functions or routines with a common theme, producing thereby a package of software functions that typically will not be complete and usable by themselves. A good package development process will help users conform to good documentation and coding practices, integrating some level of unit testing.

Selected repositories[edit]

The following table lists a few languages with repositories for contributed software. The "Autochecks" column describes the routine checks done.

Very few people have the ability to test their software under multiple operating systems with different versions of the core code and with other contributed packages they may use. For the R programming language, the Comprehensive R Archive Network (CRAN) runs tests routinely.

To understand how this is valuable, imagine a situation with two developers, Sally and John. Sally contributes a package A. Sally only runs the current version of the software under one version of Microsoft Windows, and has only tested it in that environment. At more or less regular intervals, CRAN tests Sally's contribution under a dozen combinations of operating systems and versions of the core R language software. If one of them generates an error, she gets that error message. With luck, that error message details may provide enough input to allow enable a fix for the error, even if she cannot replicate it with her current hardware and software. Next, suppose John contributes to the repository a package B that uses a package A. Package B passes all the tests and is made available to users. Later, Sally submits an improved version of A, which unfortunately, breaks B. The autochecks make it possible to provide information to John so he can fix the problem.

This example exposes both a strength and a weakness in the R contributed-package system: CRAN supports this kind of automated testing of contributed packages, but packages contributed to CRAN need not specify the versions of other contributed packages that they use. Procedures for requesting specific versions of packages exist, but contributors might not use those procedures.

Beyond this, a repository such as CRAN running regular checks of contributed packages actually provides an extensive if ad hoc test suite for development versions of the core language. If Sally (in the example above) gets an error message she does not understand or thinks is inappropriate, especially from a development version of the language, she can (and often does with R) ask the core development-team for the language for help. In this way, the repository can contribute to improving the quality of the core language software.

Language, purpose Package development process Repository Install methods Collaborative development platform Autochecks
Haskell Common Architecture for Building Applications and Libraries[6] Hackage cabal (software)
Java Maven[7]
Julia[8]
Common Lisp Quicklisp[9]
.NET NuGet NuGet[10] dotnet add package <package>
Node.js node npm,[11] yarn, bower npm install <package>

yarn add <package>

bower install <package>

Perl CPAN PPM[12] ActiveState
PHP PEAR, Composer PECL, Packagist composer require <package>

pear install <package>

Python Setuptools, Poetry[13] PyPI pip, EasyInstall, PyPM, Anaconda
R R CMD check process[14][15] CRAN[16] install.packages[17]
remotes[18] 		GitHub[19] Often on 12 platforms or combinations of different versions of R (devel, prerel, patched, release) on different operating systems (different versions of Linux, Windows, macOS, and Solaris).
Ruby RubyGems RubyGems[20] RubyGems,[20] Bundler[21]
Rust Cargo[22] crates.io[23] Cargo[22]
Go go pkg.go.dev go get <package> GitHub[19]
Dart Flutter pub.dev flutter pub get <package>
D DUB dlang.org dub add <package>
TeX, LaTeX CTAN

(Parts of this table were copied from a "List of Top Repositories by Programming Language" on Stack Overflow[24])

Many other programming languages, among them C, C++, and Fortran, do not possess a central software repository with universal scope. Notable repositories with limited scope include:

  • Netlib, mainly mathematical routines for Fortran and C, historically one of the first open software repositories;
  • Boost, a strictly curated collection of high-quality libraries for C++; some code developed in Boost later became part of the C++ standard library.

Package managers[edit]

Main article: Package manager

Package managers help manage repositories and the distribution of them. If a repository is updated, a package manager will typically allow the user to update that repository through the package manager. They also help with managing things such as dependencies between other software repositories. Some examples of Package Managers include:

Popular Package Managers
Package Manager Description
npm A package manager for Node.js[25]
pip A package installer for Python[26]
apt For managing Debian Packages[27]
Homebrew A package installer for MacOS that allows one to install packages Apple didn't[28]
vcpkg A package manager for C and C++[29][30]
yum and dnf Package manager for Fedora and Red Hat Enterprise Linux[31]
pacman Package manager for Arch Linux[32]

Repository managers[edit]

Relationship to continuous integration[edit]

As part of the development lifecycle, source code is continuously being built into binary artifacts using continuous integration. This may interact with a binary repository manager much like a developer would by getting artifacts from the repositories and pushing builds there. Tight integration with CI servers enables the storage of important metadata such as:

  • Which user triggered the build (whether manually or by committing to revision control)
  • Which modules were built
  • Which sources were used (commit id, revision, branch)
  • Dependencies used
  • Environment variables
  • Packages installed

Artifacts and packages[edit]

Artifacts and packages inherently mean different things. Artifacts are simply an output or collection of files (ex. JAR, WAR, DLLS, RPM etc.) and one of those files may contain metadata (e.g. POM file). Whereas packages are a single archive file in a well-defined format (ex. NuGet) that contain files appropriate for the package type (ex. DLL, PDB).[33] Many artifacts result from builds but other types are crucial as well. Packages are essentially one of two things: a library or an application.[34]

Compared to source files, binary artifacts are often larger by orders of magnitude, they are rarely deleted or overwritten (except for rare cases such as snapshots or nightly builds), and they are usually accompanied by much metadata such as id, package name, version, license and more.

Metadata[edit]

Metadata describes a binary artifact, is stored and specified separately from the artifact itself, and can have several additional uses. The following table shows some common metadata types and their uses:

Metadata type Used for
Versions available Upgrading and downgrading automatically
Dependencies Specify other artifacts that the current artifact depends on
Downstream dependencies Specify other artifacts that depend on the current artifact
License Legal compliance
Build date and time Traceability
Documentation Provide offline availability for contextual documentation in IDEs
Approval information Traceability
Metrics Code coverage, compliance to rules, test results
User-created metadata Custom reports and processes

See also[edit]

References[edit]

  1. ^ itmWEB: Coping with Computer Viruses Archived October 14, 2007, at the Wayback Machine
  2. ^ "JFrog Artifactory - wikieduonline". Archived from the original on 2021-03-05. Retrieved 2021-04-25.
  3. ^ "Artifactory - Universal Artifact Management". Archived from the original on 2021-05-01. Retrieved 2021-04-25.
  4. ^ "Nexus Repository | Software Component Management". Archived from the original on 2021-04-25. Retrieved 2021-04-25.
  5. ^ "Cloudsmith artifact repository". Archived from the original on 2023-07-16. Retrieved 2023-09-11.
  6. ^ "The Haskell Cabal | Overview". www.haskell.org. Archived from the original on 2019-04-10. Retrieved 2019-03-25.
  7. ^ "Maven – Welcome to Apache Maven". maven.apache.org. Archived from the original on 2011-07-24. Retrieved 2019-03-25.
  8. ^ "Julia Package Listing". pkg.julialang.org. Archived from the original on 2019-01-20. Retrieved 2019-03-25.
  9. ^ "Quicklisp beta". www.quicklisp.org. Archived from the original on 2019-03-23. Retrieved 2019-03-25.
  10. ^ karann-msft. "NuGet Package Manager UI Reference". docs.microsoft.com. Archived from the original on 2019-03-25. Retrieved 2019-03-25.
  11. ^ "npm". www.npmjs.com. Archived from the original on 2018-04-13. Retrieved 2019-03-25.
  12. ^ "Installing Perl Modules - www.cpan.org". www.cpan.org. Archived from the original on 2019-03-14. Retrieved 2019-03-25.
  13. ^ "Poetry". python-poetry.org. Archived from the original on 2024-05-22. Retrieved 2024-05-22.
  14. ^ Leisch, Friedrich. "Creating R Packages: A Tutorial" (PDF). Archived (PDF) from the original on 2017-12-09. Retrieved 2016-07-19.
  15. ^ Graves, Spencer B.; Dorai-Raj, Sundar. "Creating R Packages, Using CRAN, R-Forge, And Local R Archive Networks And Subversion (SVN) Repositories" (PDF). Archived (PDF) from the original on 2017-07-05. Retrieved 2016-07-19.
  16. ^ "The Comprehensive R Archive Network". cran.r-project.org. Archived from the original on 2019-01-23. Retrieved 2019-03-25.
  17. ^ "R Installation and Administration". cran.r-project.org. Archived from the original on 2015-11-23. Retrieved 2019-03-25.
  18. ^ Wickham, Hadley; Bryan, Jenny. "Package structure and state". R Packages. O'Reilly. Archived from the original on 2020-11-09. Retrieved 2020-11-20.
  19. ^ Jump up to: a b Decan, Alexandre; Mens, Tom; Claes, Maelick; Grosjean, Philippe (2015). "On the Development and Distribution of R Packages: An Empirical Analysis of the R Ecosystem". Proceedings of the 2015 European Conference on Software Architecture Workshops. pp. 1–6. doi:10.1145/2797433.2797476. ISBN 9781450333931. S2CID 1680582. Archived from the original on 2023-01-18. Retrieved 2021-10-26.
  20. ^ Jump up to: a b "RubyGems.org your community gem host". rubygems. Archived from the original on 2019-02-13. Retrieved 2022-02-03.
  21. ^ "Bundler: The best way to manage a Ruby application's gems". bundler.io. Archived from the original on 2022-01-29. Retrieved 2022-02-03.
  22. ^ Jump up to: a b "The Cargo Book". Documentation. Rust Programming Language. Archived from the original on 2019-04-28. Retrieved 2019-08-26.
  23. ^ "Rust Package Registry". crates.io. Archived from the original on 2019-08-28. Retrieved 2019-08-26.
  24. ^ "List of Top Repositories by Programming Language". Stack Overflow. Archived from the original on 2018-12-26. Retrieved 2010-04-14.
  25. ^ "npm About". www.npmjs.com. Archived from the original on 2019-11-19. Retrieved 2019-11-21.
  26. ^ developers, The pip, pip: The PyPA recommended tool for installing Python packages., archived from the original on 2020-07-14, retrieved 2019-11-21
  27. ^ "Apt - Debian Wiki". wiki.debian.org. Archived from the original on 2019-10-19. Retrieved 2019-11-22.
  28. ^ "Homebrew". Homebrew. Archived from the original on 2022-10-05. Retrieved 2019-11-22.
  29. ^ "Yelp launches Yelp Fusion, Microsoft creates Vcpkg tool, and the new Touch Sense SDK for Android developers". SD Times. September 20, 2016. Archived from the original on November 27, 2020. Retrieved November 19, 2020.
  30. ^ "Microsoft's C++ library manager now available for Linux and macOS". SD Times. April 25, 2018. Archived from the original on September 22, 2020. Retrieved November 19, 2020.
  31. ^ Chinthaguntla, Keerthi (22 April 2020). "Linux package management with YUM and RPM". Enable Sysadmin. Archived from the original on 2021-04-11. Retrieved 2021-04-11.
  32. ^ "pacman - ArchWiki". wiki.archlinux.org. Archived from the original on 2017-08-18. Retrieved 2021-04-11.
  33. ^ Chris, Tucker (2007-03-15). "Optimal Package Install/Uninstall Manager" (PDF). UC San Diego: 1. Archived (PDF) from the original on 2011-06-14. Retrieved 2011-09-14. {{cite journal}}: Cite journal requires |journal= (help)
  34. ^ "Linux repository classification schemes". braintickle.blogspot.com. 13 January 2006. Archived from the original on 2007-10-11. Retrieved 2008-03-01.
Retrieved from "https://en.wikipedia.org/w/index.php?title=Software_repository&oldid=1225243307"