Add GitHub API Wrapper Script and Documentation#8
Merged
alexadereyko merged 5 commits intojira/TBBAS-2677-opendaq-gh-actions-packaging-format-scriptfrom Nov 13, 2025
Conversation
alexadereyko
force-pushed
the
jira/TBBAS-2679-opendaq-gh-actions-github-api-wrapper
branch
from
909af9e to
b7e582b
Compare
alexadereyko
changed the base branch from
main
to
jira/TBBAS-2677-opendaq-gh-actions-packaging-format-script
alexadereyko
force-pushed
the
jira/TBBAS-2677-opendaq-gh-actions-packaging-format-script
branch
from
b059a96 to
e0eec35
Compare
alexadereyko
force-pushed
the
jira/TBBAS-2679-opendaq-gh-actions-github-api-wrapper
branch
from
5f398ae to
384ae9d
Compare
alexadereyko
force-pushed
the
jira/TBBAS-2677-opendaq-gh-actions-packaging-format-script
branch
from
e0eec35 to
4988b4e
Compare
alexadereyko
force-pushed
the
jira/TBBAS-2679-opendaq-gh-actions-github-api-wrapper
branch
from
384ae9d to
a512e88
Compare
alexadereyko
force-pushed
the
jira/TBBAS-2677-opendaq-gh-actions-packaging-format-script
branch
from
4988b4e to
c2c2587
Compare
Features: - Version resolution (latest, specific tags) - Release version listing with limit support - Compatible with bash 3.2+ and zsh Documentation: - Add README.md with CLI usage and integration examples - Update CONVENTIONS.md for API wrapper modules
alexadereyko
force-pushed
the
jira/TBBAS-2679-opendaq-gh-actions-github-api-wrapper
branch
from
a512e88 to
c3fc444
Compare
added 4 commits
November 13, 2025 13:15
…n, platform, and packaging format components. Features: - Auto-resolve latest version from openDAQ/openDAQ repository - Auto-detect current platform (104 supported combinations) - Auto-detect packaging format from runner OS or CPack generator - Validate and parse version/platform/packaging components - Output individual components for downstream use Supported formats: - Version: semantic versioning with optional prefix/suffix/hash (v3.30.0, v3.29.0-rc, v3.30.0-a1b2c3d, etc) - Platform: Linux/macOS/Windows across multiple versions (ubuntu22.04-x86_64, macos14-arm64, win64, etc) - Packaging: .deb, .exe, .tar.gz, .zip Action outputs: - Complete filename (e.g., opendaq-v3.30.0-ubuntu22.04-x86_64.deb) - Parsed version components (major, minor, patch, suffix, hash) - Parsed platform components (os-name, os-version, os-arch) - Resolved packaging format Integration: - Uses shell scripts: version-format.sh, platform-format.sh, packaging-format.sh - Cross-platform compatible (Linux, macOS, Windows runners) Documentation: - Comprehensive README with format specifications - Usage examples for all common scenarios - Input/output parameter reference
Features: - Windows: Silent installation via .exe with PATH configuration - Linux: Installation via dpkg for .deb packages - Error handling and exit code validation - Comprehensive documentation with multiple usage examples Supported platforms: - Windows (via .exe installer) - Linux (via .deb package)
Fixed behaviour of platform-format.sh by replacing exit with return
alexadereyko
merged commit dcfbfe6
into
jira/TBBAS-2677-opendaq-gh-actions-packaging-format-script
6 checks passed
alexadereyko
deleted the
jira/TBBAS-2679-opendaq-gh-actions-github-api-wrapper
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add GitHub API Wrapper Script and Documentation
Summary
New script
api-github-gh.sh- bash/zsh wrapper for GitHub CLI providing convenient functions for releases, assets, artifacts, and workflow runs management.Changes
Script
Documentation
Key Points
The script uses
daq_api_gh_prefix instead ofdaq_gh_to:Proposed CONVENTIONS.md Updates
api-github-gh.shto module prefixes table