The Funtoo Linux project has transitioned to "Hobby Mode" and this wiki is now read-only.
Funtoo Harvester Project
harvester/2023-11 has been merged into official Funtoo, and harvester/2024-02 has been created. Please hold off on PRs to harvester. We are going to define a more structured approach to harvester development very soon so we can move forward strategic initiatives.
01 February 2024
To submit a PR for harvester, please send a PR via code.funtoo.org and target the harvester/2022-09 branch of kit-fixups.
coffnix is the master of the harvest and you should be sure to stay in contact with him in the #harvester channel on Funtoo Discord
if you are using harvester.
Welcome to the harvester project!
The harvester project is focused on providing a meta-repo that can be used for active development by Funtoo Linux contributors. This allows evaluation of experimental and potentially disruptive changes in a completely separate tree without impacting regular Funtoo Linux installs.
The Harvester Concept
Harvester exists as a branch of kit-fixups, which is listed at the top of this page.
harvester.funtoo.org generates a tree using this special branch, containing
experimental changes. These changes are made available via git from harvester.funtoo.org directly.
Frequently Asked Questions
- What issues are you solving with harvester?
- We need a "testing release" to test imminent changes to our releases, compatible with CI (continuous integration), to accelerate development and improve quality and test-ability of our imminent changes before they hit production systems.
- How does this relate to
next-release in general? I thought that this was supposed to be the "experimental" branch? next-release was meant to be a very up-to-date rolling release but still actually be useful for real work. So,next-release should not become a mechanism to integration-test potentially disruptive changes to Funtoo, nor is it a good candidate for CI to run tests. This has become more important now thatnext-release is the official recommended default install for new Funtoo Linux systems, due to it being much more current than1.4-release. This means that we should keep it more current, but also keep it functioning well and improve its reliability and usefulness. Thus, we have a harvesternext-release where we can test and stabilize things before they are rolled into the officialnext-release, allowing problems can be identified proactively -- before they impact production systems. This will actually speed up development ofnext-release.
- Why not create a
unstable-release, then? Why harvester? - Good question. Creating a new
unstable-release is not a useful option because it will diverge fromnext-release over time and then ultimately we will re-create the issue we are trying to solve, which is to have a CI-compatible release where we can push potentially breaking changes for manual and automated testing to something that very closely resembles our current production releases. Harvester also can provide us with a CI-friendly fork of all of our releases, so it can allow us to test potentially breaking changes destined for any of our releases.
- What releases are available in harvester?
- The
nextrelease is currently being generated and is available fromharvester.funtoo.org(See below.)
- Is there a 1.4-release harvester tree?
- We are not currently generating a harvester version of
1.4-release, but this could be added in the future.
- How will harvester be synchronized with the official releases?
- We have options here, but the overall concept is that we have a kit-fixups branch like
harvester/2022-09that is always forked from the official upstream releases of Funtoo. So periodically, we re-sync with the official release by creating a new timestamped harvester branch, before adding experimental changes. The frequency is something we control.
- How will changes in harvester be added to official releases?
- Again, we have options here. If we have a bunch of experimental changes in harvester, and they all get worked on and become quite reliable, we can directly merge the harvester branch into master. Or, if only some changes become stable, the ones that are stable can be sent as PR's into master (the official releases.) Or, if we try a bunch of things that are a total disaster, we can abandon the timestamped harvester branch and create a new one, and just abandon the changes. So we have the ability to adapt as needed and don't need to have a 'set in stone' git flow.
How To Use
Currently, harvester only provides an experimental next-release tree.
To use harvester on an existing next-release system, add the following lines to your
/etc/ego.conf:
/etc/ego.conf [global]
release = next
sync_base_url = git://harvester.funtoo.org/funtoo/tree/{repo}
Then, back up your existing meta-repo, and re-sync the new harvester meta-repo:
root # cd /var/git root # mv meta-repo meta-repo.bak root # ego sync
Your system will now have the harvester next-release meta-repo available to it,
so you can test the latest experimental changes in harvester via emerge.
How To Submit
As with all PR's, it is required that you open an issue on bugs.funtoo.org. Once
this is done, and the issue has been triaged so that is no longer in the "Intake" state,
it is possible to start progress on the issue and submit a PR referencing the issue,
targeting the kit-fixups branch listed at the top of the page. The PR will be on an
accelerated track to be merged into harvester. When the harvester tree is next regenerated, the change will appear in the tree and ego sync will make it available on any Funtoo Linux systems using harvester.
Once your changes have been sufficiently tested, it is then possible to submit a vetted PR to the production next-release tree, by submitting a PR to the kit-fixups master branch.
Using Sourced Kits
Most kits can receive new ebuilds and autogens via kit-fixups, and thus it is easy to add experimental ebuilds and autogens to most kits, but there are exceptions.
Any "sourced" kits are kits that are fully self-contained in their own repos, such as
gnome-kit-sources. You can find a full list of sourced kits by looking at kit-fixups/browse/releases/next/repositories.yaml -- any kit with kind: sourced
is a sourced kit. This means that kit-fixups isn't used to "tweak" the contents of the kit -- instead, the ebuilds and autogens
come from the referenced branch as-is, and all updates appear in this separate "sources" repo and branch.
This creates a problem for harvester -- how do you inject experimental changes into sourced kits? The answer is to coordinate with
our master of the harvest so that we can create a special harvester branch on the sourced kit for you, and update our YAML so that
this harvester branch is used for our harvester tree. Basically, we will create a harvester/YYYY-MM branch in the sourced kit,
and then you submit the PR against that. We don't do this automatically since many kits are not sourced and the creation of these
branches is not yet automated.
We will probably automate the creation of harvester branches for sourced kits in the near future, and add details here about how to submit to harvester for sourced kits.