https://github.com/platomo/build-release-asset-action

https://github.com/platomo/build-release-asset-action

actions

Last synced: 12 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/platomo/build-release-asset-action
• Owner: platomo
• License: gpl-3.0
• Created: 2024-10-31T09:02:54.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-11-04T10:11:08.000Z (3 months ago)
• Last Synced: 2024-11-17T20:52:59.174Z (2 months ago)
• Topics: actions
• Language: Shell
• Homepage:
• Size: 17.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# Build Release Assets

This GitHub Action builds release assets by checking out the Platomo build repository, installing dependencies, and executing the release build. Optionally, it can save the build artifacts for later use.

## Usage

### Inputs

- **`platomo-token`** (required): Access token for the Platomo Builder repository.

- **`package-version`** (required): Version number of the package to be built.

- **`save-artifacts`** (optional): Indicates if the build artifacts should be archived and saved.

### Example Workflow

Here’s an example of how to use the `Build Release Assets` action in a workflow:

```yaml

name: Build Release Assets

on:

  push:

    tags:

      - 'v*.*.*'

jobs:

  build-release:

    runs-on: ubuntu-latest

    steps:

      - name: Build Release Assets

        uses: ./.github/actions/build-release-assets

        with:

          platomo-token: ${{ secrets.PLATOMO_TOKEN }}

          package-version: '1.2.3'

          save-artifacts: true

```

## How It Works

1. **Check Out Repository**: The action checks out the `platomo-build` repository using the provided access token.

2. **Install Dependencies**: Installs dependencies specified in `requirements.txt` and `requirements-dev.txt` if they exist.

3. **Build Release Assets**: Runs the `build.py` script in the Platomo repository to generate release assets based on the specified package version.

4. **Archive Results**: Optionally saves build results as artifacts, if `save-artifacts` is set to `true`.

### Notes

- Ensure the `platomo-token` has permissions to access the `platomo-build` repository.

- Specify the correct package version for each release.

- If `save-artifacts` is set to `true`, the build results will be archived as `build-results` under the `dist` directory.