A GitHub Action and local tool for locating and processing release source code from GitHub repositories.
- Locates GitHub releases by repository and tag
- Downloads release source code
- Uploads source code to modules.wippy.ai
- Supports both GitHub Actions and local execution
Add the following to your workflow file (.github/workflows/your-workflow.yml
):
name: Release Module
on:
release:
types: [published]
jobs:
release:
runs-on: ubuntu-latest
steps:
- uses: wippyai/module-release-locator@v1
with:
repository: ${{ github.repository }}
tag: ${{ github.ref_name }}
token: ${{ secrets.GITHUB_TOKEN }}
module_id: "your-module-uuid"
username: ${{ secrets.WIPPY_USERNAME }}
password: ${{ secrets.WIPPY_PASSWORD }}
- Clone the repository:
git clone https://github.com/wippyai/module-release-locator.git
cd module-release-locator
- Make the script executable:
chmod +x main.sh
- Run the script:
./main.sh \
--repository "owner/repo" \
--tag "v1.0.0" \
--token "your-github-token" \
--module-id "your-module-uuid" \
--username "your-wippy-username" \
--password "your-wippy-password"
--repository
: GitHub repository in formatowner/repo
(e.g.,wippyai/module-hello
)--tag
: Release tag to locate (e.g.,v1.0.0
)--token
: GitHub token for authentication--module-id
: UUID of the module to upload to--username
: Username for modules.wippy.ai authentication--password
: Password for modules.wippy.ai authentication
The script will automatically install required dependencies:
- jq (for JSON processing)
- Docker (for building and running the upload tool)
The script provides the following outputs:
- Release URL
- Source code URL
The script includes error handling for:
- Missing required parameters
- Invalid repository/tag combinations
- Network issues
- Authentication failures
To modify the functionality:
- Edit the main script in
main.sh
- Test locally using the provided usage instructions
- Update the GitHub Action in
action.yml
if needed