Skip to content

github.md

Latest commit

 

History

History
60 lines (40 loc) · 3.01 KB

github.md

File metadata and controls

60 lines (40 loc) · 3.01 KB

github google localhost ru en

Build Padavan firmware with Github Actions

Usage

  1. Create a copy (fork) of this repository:

    fork

  2. (Optional) Configure build variables:

    • In your fork, open the build.conf file at the root of the repository.
    • Modify the variables according to your requirements.
    • For a description of the variables, see the table build.conf.

  3. (Optional) Configure build settings:

    • Open the build.config file at the root of the repository and edit it according to your requirements.
    • This step is optional if you have specified a path to a different configuration file in the PADAVAN_CONFIG variable.
    • You can find a template config for your device in the firmware repository.

  4. (Optional) Add your custom scripts:

    • Create a file pre_build.sh at the root of the repository to execute commands before building the firmware.
    • Create a file post_build.sh at the root of the repository to execute commands after building the firmware.

  5. Start the build:

    • Navigate to the Actions section of your fork on Github.
    • Select the workflow Build firmware.
    • Click "Run workflow", select a branch, and confirm the launch by clicking the "Run workflow" button:

    build

  6. Download the firmware:

    • After the build is successful (usually takes 15 minutes to an hour), go to the "Summary" tab on the workflow run page.
    • In the Artifacts section, click the download button next to the name of your archive:

    zip

Updating the fork

Periodically, updates may be made to this repository. To get these updates in your fork, follow these steps:

  1. Open the page of your fork on Github.

  2. You will see a notification that your fork is behind the original repository if updates are available.

  3. Click the "Sync fork" button, and then "Update branch":

    update

  4. Wait for the synchronization to complete.

If your fork is already up-to-date, you will see the following notification:

not update

Additional information

  • The Padavan firmware license does not allow distribution of pre-built binaries. Compiled firmware is for personal use only. The archive with your firmware will be stored in Github Actions for 7 days.