creating apio version - zapta/apio-new-doc-wiki.delete-me GitHub Wiki


THIS PAGE IS IN DRAFT STATUS AND NEEDS MORE WORK.



Creating a new apio version

Cutting a release candidate

Visit the Apio daily build repository, determine the release that you want to use, and identity its apio-commit, e.g. ff0e252159e9f8112a9214339717c2b0b9b4cef9.

Testing a release candidate

Perform the following for each of the supported platforms:

  1. Launch manually the Apio test workflow, provide it with the candidate commit as input (TBD), and wait for the test to pass successfully.
  2. Perform the following tests on each of the supported platforms:
    1. Test the build files (bundles, packages, and installers, ) from the build release.
    2. Test the Apio commit as a pip package by installing it as follows:
# Replace with the actual commit sha.
commit="ff0e252159e9f8112a9214339717c2b0b9b4cef0"

# Install the apio package from the selected commit.
pip install --force-reinstall -U git+https://github.com/FPGAwars/apio.git@${commit}#egg=apio

# Open a new shell windows for the $PATH update to get affect.

Releasing the new version

  1. Run manually the Apio publish workflow and provide it with the build tag and commit sha.

  2. Install and test the new package from pypi

pip uninstall apio
pip install apio
  1. Add the bundle, package and installer files from the build repo to the new release.

⚠️ **GitHub.com Fallback** ⚠️