{"id":23714363,"url":"https://github.com/calinradoni/esp-idf-v4-action","last_synced_at":"2025-09-03T18:32:05.239Z","repository":{"id":65157514,"uuid":"303199616","full_name":"CalinRadoni/esp-idf-v4-action","owner":"CalinRadoni","description":"GitHub Action to build your ESP32 firmware with ESP-IDF development framework v4.x","archived":false,"fork":false,"pushed_at":"2022-08-14T04:46:47.000Z","size":13,"stargazers_count":5,"open_issues_count":1,"forks_count":6,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-19T18:18:25.527Z","etag":null,"topics":["esp-idf","github-actions"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CalinRadoni.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-11T19:45:00.000Z","updated_at":"2023-06-27T07:27:35.000Z","dependencies_parsed_at":"2023-01-13T15:43:09.881Z","dependency_job_id":null,"html_url":"https://github.com/CalinRadoni/esp-idf-v4-action","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CalinRadoni%2Fesp-idf-v4-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CalinRadoni%2Fesp-idf-v4-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CalinRadoni%2Fesp-idf-v4-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CalinRadoni%2Fesp-idf-v4-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CalinRadoni","download_url":"https://codeload.github.com/CalinRadoni/esp-idf-v4-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231908083,"owners_count":18444250,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["esp-idf","github-actions"],"created_at":"2024-12-30T20:19:14.997Z","updated_at":"2024-12-30T20:19:15.649Z","avatar_url":"https://github.com/CalinRadoni.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ESP-IDF v4.x installer\n\nGitHub Action to install Espressif IoT Development Framework v4.x for building ESP32 code.\n\n**Note:** [ESP-IDF v4.x build](https://github.com/marketplace/actions/esp-idf-v4-x-build) is faster to use as a GitHub Action for\nbuilding ESP32 code. It uses Espressif's official Docker container skipping the whole installation part.\n\nThe usable ESP-IDF versions are:\n\n- `latest` (based on release/v4.2)\n- `v4.2`, v4.2.x, `release/v4.2`\n- `v4.1`, v4.1.x, `release/v4.1`\n- v4.0.x, `release/v4.0`\n\n**Note:** The action is built for Ubuntu 20.04 LTS. It may or may not work with other Ubuntu or Debian versions.\n\n## Usage\n\nSource the ESP-IDF required environment variables before building your code:\n\n```sh\nsource ~/esp/esp-idf/export.sh\nidf.py build\n```\n\nIt is used at least in [ESP32HAL](https://github.com/CalinRadoni/ESP32HAL) repository.\n\n### Example\n\n```yml\nname: ESP32 Builder\n\non: [push]\n\njobs:\n  builder:\n    name: Builder for test ESP32 project\n    runs-on: ubuntu-20.04\n\n    steps:\n      - name: Checkout code\n        uses: actions/checkout@v2\n\n      - name: Install ESP-IDF\n        uses: CalinRadoni/esp-idf-v4-action@v2\n        with:\n          esp_idf_version: 'v4.1'\n\n      - name: Build\n        run: |\n          source ~/esp/esp-idf/export.sh\n          idf.py reconfigure\n          idf.py app\n          idf.py size\n```\n\n## About\n\nIt was tested in the official Ubuntu Focal Docker container and it contains some minor extra steps not really needed for the GitHub-hosted Ubuntu 20.04 LTS runner, like the installation of `tzdata` and `python3-libusb1`. I left them for completeness if more tests are needed.\n\nVersion 2 of this action does not build the ESP32 code, like version 1 has done it, to allow custom build steps.\n\n## License\n\nThis repository is licensed with the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcalinradoni%2Fesp-idf-v4-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcalinradoni%2Fesp-idf-v4-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcalinradoni%2Fesp-idf-v4-action/lists"}