Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/espressif/upload-components-ci-action
GitHub Action to upload ESP-IDF components to the component registry
https://github.com/espressif/upload-components-ci-action
ci espressif github-actions
Last synced: 2 days ago
JSON representation
GitHub Action to upload ESP-IDF components to the component registry
- Host: GitHub
- URL: https://github.com/espressif/upload-components-ci-action
- Owner: espressif
- License: apache-2.0
- Created: 2022-06-22T12:35:43.000Z (over 2 years ago)
- Default Branch: v1
- Last Pushed: 2024-08-19T11:49:41.000Z (about 1 month ago)
- Last Synced: 2024-08-19T13:27:38.199Z (about 1 month ago)
- Topics: ci, espressif, github-actions
- Language: Shell
- Homepage:
- Size: 21.5 KB
- Stars: 6
- Watchers: 6
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Action to upload ESP-IDF components to the component registry
This action uploads [ESP-IDF](https://github.com/espressif/esp-idf) components from a GitHub repository to [Espressif Component Registry](https://components.espressif.com).
## Usage
The action requires `api_token` and `namespace` parameters to be set. If the repository contains the only component stored in the root of the repository, then the `name` parameter is also required. If the repository contains more than 1 component in subdirectories, it's necessary to set the `directories` parameter to the semicolon-separated list of directories with components. In this case, the base name of the directory will be used as a component name.
### Handling versions
If the version in the manifest file is not in the registry yet this action will upload it. Every version of the component can be uploaded to the registry only once.
It's recommended to change the version in the manifest only when it's ready to be published.
An alternative supported workflow is to set parameter `skip_pre_release` to any non-empty string and use [pre-release](https://semver.org/#spec-item-9) versions (like `1.0.0-dev`) during development and then change the version to a stable (like `1.0.0`) for release.
If the version of the component is not specified in the manifest file, you can use the `version` parameter. It must be a valid [semantic version](https://semver.org/) optionally prefixed with the character "v". I.e. versions formatted like `v1.2.3` or `1.2.3` are supported.
If the component with the same version is already in the registry the action will skip uploading silently.
### Example workflows
#### Uploading one component with the version from the git tag
To upload components only on tagged commits add an on-push-tags rule to the workflow and set `version` input to `${{ github.ref_name }}`.
```yaml
name: Push component to https://components.espressif.com
on:
push:
tags:
- v*
jobs:
upload_components:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
submodules: "recursive"
- name: Upload component to the component registry
uses: espressif/upload-components-ci-action@v1
with:
name: "my_component"
version: ${{ github.ref_name }}
namespace: "espressif"
api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}
```
#### Uploading multiple components from the current repository
```yaml
name: Push components to https://components.espressif.com
on:
push:
branches:
- main
jobs:
upload_components:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
submodules: "recursive"
- name: Upload components to the component registry
uses: espressif/upload-components-ci-action@v1
with:
directories: "components/my_component;components/another_component"
namespace: "espressif"
api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}
```
#### Uploading a component through a workflow from a different repository
```yaml
name: Push component to https://components.espressif.com
on:
push:
branches:
- main
jobs:
upload_components:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
submodules: "recursive"
repository: "another/repository"
- name: Save information about repository to the github environment
run:
echo "GITHUB_REPOSITORY_URL=`git config --get remote.origin.url`" >> "$GITHUB_ENV";
echo "GITHUB_COMMIT_SHA=`git rev-parse HEAD`" >> "$GITHUB_ENV";
- name: Upload components to the component registry
uses: espressif/upload-components-ci-action@v1
with:
name: "example"
namespace: "espressif"
api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}
repository_url: ${{ env.GITHUB_REPOSITORY_URL }}
commit_sha: ${{ env.GITHUB_COMMIT_SHA }}
```
## Parameters
| Input | Optional | Default | Description |
| ---------------- | -------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- |
| api_token | ❌ | | API Token for the component registry |
| namespace | ❌ | | Component namespace |
| name | ✔ / ❌ | | Name is required for uploading a component from the root of the repository |
| version | ✔ | | Version of the component, if not specified in the manifest. Should be a [semver](https://semver.org/) like `1.2.3` or `v1.2.3` |
| directories | ✔ | Repo root | Semicolon separated list of directories with components. |
| skip_pre_release | ✔ | False | Set this flag to `true`, `t`, `yes` or `1` to skip [pre-release](https://semver.org/#spec-item-9) versions. |
| dry_run | ✔ | False | Set this flag to `true`, `t`, `yes` or `1` to upload a component for validation only without creating a version in the registry. |
| service_url | ✔ | https://components.espressif.com/api | (Deprecated, use "registry_url") IDF Component registry API URL |
| registry_url | ✔ | https://components.espressif.com/ | IDF Component registry URL |
| repository_url | ✔ | Current working repository | URL of the repository where component is located. Set to empty string if you don't want to send the information about the repository. |
| commit_sha | ✔ | Current commit sha | Git commit SHA of the the component version. Set to empty string if you don't want to send the information about the repository. |