Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
licenses
media-libs media-sound/libmonome bump to 1.4.2 Jul 4, 2018
media-plugins Add media-plugins/fabla (#109) Oct 29, 2017
media-sound media-sound/synthv1 drop old Aug 19, 2018
metadata Ensure we only use EAPI6 (#44) Jun 23, 2017
profiles Add initial repo metadata May 23, 2017
tests tests: allow package specific test config without version Jun 30, 2018
x11-libs/ntk x11-libs/ntk: Use HTTPS as git protocol Oct 17, 2017
.editorconfig Add editorconfig May 27, 2017
.gitignore Add script to publish package list to GitHub Pages Jan 26, 2018
.travis.yml Tests: Add random non-live ebuild emerge to daily tests Mar 20, 2018
LICENSE Initial commit May 23, 2017
README.md

README.md

Audio overlay Build Status

Gentoo/Funtoo overlay containing pro audio applications

How to use this overlay

[audio-overlay]
location = /<path>/<to>/<your>/<overlays>/audio-overlay
sync-type = git
sync-uri = https://github.com/gentoo-audio/audio-overlay.git
auto-sync = yes
  • Or if you use layman add the overlay using layman -a audio-overlay and sync using layman -s audio-overlay

Contact

Join us at the #proaudio-overlay channel at irc.freenode.org or create an issue.

Quality control

  • GitHub's branch protection is enabled for the master branch.
  • Changes can only be done using pull requests and need at least one approval.
  • Pull requests can only be merged if they pass the automated tests, which are run by Travis CI.
    We have a zero-tolerance policy for test failures and warnings, only changes that have no failures and warnings are merged.

Automated tests

All tests that are meant to be executed by the user or by CI can be found in the ./tests directory.

All tests need app-emulation/docker to be installed.

Pull Requests

Every pull request must pass the following tests before it can be merged:

  • Validation if the ebuild(s), metadata and other overlay files are correct. This is done using repoman.
    Run this test using ./tests/repoman.sh.
  • Validation if the ebuilds that are new or changed in the Pull Request can be emerged. This is done in a clean amd64 stage3.
    Run this test using ./tests/emerge-new-or-changed-ebuilds.sh from the branch which contains the new or changed ebuild(s).
    Note that this will create a binary package cache at ${HOME}/.portage-pkgdir.

Daily checks

Every day the following tests are run:

  • A random ebuild is picked and emerged to validate that it can still be emerged correctly. This is done in a clean amd64 stage3.
    Run this test using ./tests/emerge-random-ebuild.sh.
    Note that this will create a binary package cache at ${HOME}/.portage-pkgdir.
  • A check if a new version of any of the packages in the overlay is released. This is done using newversionchecker. If a new version has been released an issue requesting a version bump will be created.
    Run this test using ./tests/newversioncheck.sh.

Development

To check if an ebuild you're working on can be emerged without issue use ./tests/emerge-ebuild.sh <path>/<to>/<ebuild>.ebuild. This is done in a clean amd64 stage3.
For example to emerge the ebuild media-sound/somesynth/somesynth-1.2.3.ebuild run ./tests/emerge-ebuild.sh media-sound/somesynth/somesynth-1.2.3.ebuild.
Note that this will create a binary package cache at ${HOME}/.portage-pkgdir.

Also see the tests described under Pull Requests.

Test configuration

All test configuration can be found in ./tests/resources.

Emerge tests

To enable configuring packages for the emerge tests a .conf file matching the package is sourced before the package is emerged. These .conf files should be placed in the ./tests/resources/packages directory using the same package category structure as the overlay itself.
For example to configure the package media-sound/somesynth-1.2.3 the .conf file should be called ./tests/resources/packages/media-sound/somesynth-1.2.3.conf.

New version check

The new version check uses ./test/resources/newversionchecker.toml as it's configuration.