Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rename CI workflows #232

Merged
merged 5 commits into from
Mar 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: cell_census build
name: Python cell_census build
mlin marked this conversation as resolved.
Show resolved Hide resolved

on:
pull_request:
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: cell_census Python package unit tests
name: Python cell_census package unit tests

on:
pull_request:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: cell_census R package checks
name: R CellCensus package checks

on:
pull_request:
Expand Down
6 changes: 3 additions & 3 deletions api/python/cell_census/release_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ While not strictly required, this process assumes you have met the following pre

## Step 1: Building the package assets

A build will occur automatically upon each commit to main, upon each commit to a PR, or when the build workflow is manually invoked. The build workflow is defined by the GH `build.yml` workflow. Build artifacts are the Python setuptools-created `sdist` and `wheel`, and are retained for a limited period of time (currently the GH default of 90 days).
A build will occur automatically upon each commit to main, upon each commit to a PR, or when the build workflow is manually invoked. The build workflow is defined by the GH `py-build.yml` workflow. Build artifacts are the Python setuptools-created `sdist` and `wheel`, and are retained for a limited period of time (currently the GH default of 90 days).

Unless you are revising and testing the build process itself, there is no need to manually perform a build.

Expand Down Expand Up @@ -75,9 +75,9 @@ To create a release, perform the following:
$ git tag -a <SEMVER> -m 'Release <SEMVER>'
$ git push origin <SEMVER>
```
3. Trigger a build for this tag by manually triggering the `build.yml` workflow. For example:
3. Trigger a build for this tag by manually triggering the `py-build.yml` workflow. For example:
```shell
$ gh workflow run build.yml --ref <SEMVER>
$ gh workflow run py-build.yml --ref <SEMVER>
```
4. When the workflow completes, make note of the run ID (e.g., using `gh run list`).
5. Optional, _but recommended_: download the asset from the build workflow and validate it.
Expand Down