Skip to content

Commit

Permalink
ci: add workflows description
Browse files Browse the repository at this point in the history
  • Loading branch information
maxim-v4s committed Aug 13, 2024
1 parent 9a89e91 commit 80c5e80
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 1 deletion.
7 changes: 6 additions & 1 deletion .github/workflows/build.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# This workflow is used for manual (can be triggered via GitHub web interface)
# build of package archives for distribution. The build workflow
# (.github/workflows/reusable-build.yaml) is triggered for creation wheel and
# sdist package archives.

name: Build python package manually
on:
workflow_dispatch

jobs:
build:
uses: qua-platform/qualibrate-runner/.github/workflows/reusable-buld.yaml@main
uses: qua-platform/qualibrate-runner/.github/workflows/reusable-build.yaml@main
4 changes: 4 additions & 0 deletions .github/workflows/check.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# This workflow is used for automatically running checks on adding commit to
# pull requests. This workflow triggers poe (poethepoet) commands: type, lint,
# format. The commands are defined in pyproject.toml.

name: Format; lint; type; tests
on:
pull_request
Expand Down
5 changes: 5 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# This workflow is used for creating draft release on GitHub. Firstly the
# build workflow (.github/workflows/reusable-buld.yaml) is triggered for
# creation wheel and sdist package archives. Then the draft GitHub release is
# created with attached built python package archives.

name: Create release

on:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# This workflow is used for building qualibrate-runner python package in dist
# and wheel formats. Built archives is attached to run as artifacts. The
# workflow should only be automatically triggered by other workflows (manual
# build and release).

name: Build python package
on:
workflow_call
Expand Down

0 comments on commit 80c5e80

Please sign in to comment.