From 58a398fb343e8a16c6340789e854056e3782802c Mon Sep 17 00:00:00 2001 From: Paul Adkisson Date: Thu, 29 Aug 2024 04:03:31 +1000 Subject: [PATCH] Update Check Docstrings workflow to use new github action (#354) * added private and skippable fns to check * updated check docstrings call * update syntax to work with actions * updated changelog * ref_name --> ref --- .github/workflows/check-docstrings.yaml | 14 +++++++++----- CHANGELOG.md | 1 + 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/.github/workflows/check-docstrings.yaml b/.github/workflows/check-docstrings.yaml index 1cc2eb7c..91814649 100644 --- a/.github/workflows/check-docstrings.yaml +++ b/.github/workflows/check-docstrings.yaml @@ -5,8 +5,12 @@ on: jobs: check-docstrings: - uses: catalystneuro/.github/.github/workflows/check_docstrings.yaml@main - with: - python-version: '3.10' - repository: 'catalystneuro/roiextractors' - package-name: 'roiextractors' + runs-on: ubuntu-latest + steps: + - id: check_docstrings + uses: catalystneuro/.github/.github/actions/check_docstrings@main + with: + python-version: '3.10' + repository: 'catalystneuro/roiextractors' + package-name: 'roiextractors' + branch: ${{ github.ref }} diff --git a/CHANGELOG.md b/CHANGELOG.md index a846c99e..856c85f6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -28,6 +28,7 @@ * Optimize parsing of xml with `lxml` library for Burker extractors: [#346](https://github.com/catalystneuro/roiextractors/pull/346) * Protect sima and dill export [#351](https://github.com/catalystneuro/roiextractors/pull/351) * Improve error message when `TiffImagingExtractor` is not able to form memmap [#353](https://github.com/catalystneuro/roiextractors/pull/353) +* Updated Check Docstrings workflow to use new github action: [#354](https://github.com/catalystneuro/roiextractors/pull/354) ### Testing