Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/insightsengineering/cran-status-monitor
Github Action to check for issues reported on CRAN status page
https://github.com/insightsengineering/cran-status-monitor
actions github-actions r
Last synced: 1 day ago
JSON representation
Github Action to check for issues reported on CRAN status page
- Host: GitHub
- URL: https://github.com/insightsengineering/cran-status-monitor
- Owner: insightsengineering
- License: apache-2.0
- Created: 2023-04-12T12:35:16.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-15T16:04:06.000Z (11 months ago)
- Last Synced: 2024-12-28T15:48:31.854Z (about 2 months ago)
- Topics: actions, github-actions, r
- Language: R
- Homepage: https://github.com/marketplace/actions/cran-status-monitor
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CRAN Status Monitor
### Description
Creates a summary of issues reported on the CRAN status check page for a given R package.
### Action Type
Composite.
### Inputs
* `statuses`:
_Description_: Create an issue if one or more of the following
statuses are reported on the check report.
This is a comma-separated string of statuses.
Allowed statuses are 'NOTE', 'WARN', and 'ERROR'
_Required_: `false`
_Default_: `ERROR`
* `issue-assignees`:
_Description_: To whom should the issue be assigned to if errors are
encountered in the CRAN status checks?
This is a comma-separated string of GitHub usernames.
If undefined or empty, no assignments are made.
_Required_: `false`
_Default_: `''`
* `path`:
_Description_: Path to the R package root, if the package is not at the
top level of the repository.
_Required_: `false`
_Default_: `.`
### Outputs
None
### Example usage:
```yaml
jobs:
cran-status:
name: Check Status
runs-on: ubuntu-latest
container:
image: rocker/tidyverse:latest
steps:
- name: Run CRAN Status Action
uses: insightsengineering/cran-status-action@main
with:
statuses: "ERROR"
issue-assignees: "username1"
```
We acknowledge that a similar action, based on code from [pharmaverse/admiralci](https://github.com/pharmaverse/admiralci) repository, has been created: https://github.com/dieghernan/cran-status-check.
The action contained in this repository is simply our take on how to perform the CRAN status check 😄