kevinmatthes/create-scriv-fragment

A GitHub Action to create a blank Scriv fragment.

https://github.com/kevinmatthes/create-scriv-fragment

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (8.2%) to scientific vocabulary

Keywords from Contributors

hack standardization meshing pipeline-testing datacleaner data-profilers sequences bridges interpretability argument-parser
Last synced: 10 months ago · JSON representation ·

Repository

A GitHub Action to create a blank Scriv fragment.

Basic Info
  • Host: GitHub
  • Owner: kevinmatthes
  • License: gpl-3.0
  • Default Branch: main
  • Size: 130 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 1
  • Releases: 7
Created over 3 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog License Citation Codeowners

README.md

create-scriv-fragment

Summary

A GitHub Action to create a blank Scriv fragment.

  1. License
  2. Description
  3. Branding Information

License

This project's license is GPL-3.0. The whole license text can be found in LICENSE in the main directory of this repository. The brief version is as follows:

Copyright (C) 2023 Kevin Matthes

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

License information about the dependencies this software requires to work can be found in LICENSEs.

Description

This GitHub Action will create a new Scriv fragment. It assumes that Scriv is already configured and that the fragment storage exists. The user creating the fragment will be the GitHub Actions bot.

It is recommended to execute this Action on a Linux runner. This Action requires a Bash shell environment. The repository needs to be checked out before the Action can be called. After it has finished, the changeds need to be pushed back to the repository. There are neither inputs nor outputs.

To apply this Action, just add the following to the step section of a GitHub Action workflow job.

yaml - uses: kevinmatthes/create-scriv-fragment@v0.2.3

Branding Information

The branding of this Action uses the icon book on a green background. The shall symbolise the documentation which is going to be enriched with further information while the green colour represents the creation of the therefore required Scriv fragment.

Owner

  • Name: Kevin Matthes
  • Login: kevinmatthes
  • Kind: user

Citation (CITATION.cff)

######################## GNU General Public License 3.0 ########################
##                                                                            ##
## Copyright (C) 2023 Kevin Matthes                                           ##
##                                                                            ##
## This program is free software: you can redistribute it and/or modify       ##
## it under the terms of the GNU General Public License as published by       ##
## the Free Software Foundation, either version 3 of the License, or          ##
## (at your option) any later version.                                        ##
##                                                                            ##
## This program is distributed in the hope that it will be useful,            ##
## but WITHOUT ANY WARRANTY; without even the implied warranty of             ##
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              ##
## GNU General Public License for more details.                               ##
##                                                                            ##
## You should have received a copy of the GNU General Public License          ##
## along with this program.  If not, see <https://www.gnu.org/licenses/>.     ##
##                                                                            ##
################################################################################

################################################################################
##
##  AUTHOR      Kevin Matthes
##  BRIEF       Citation settings for the Git repository.
##  COPYRIGHT   GPL-3.0
##  DATE        2023
##  FILE        CITATION.cff
##  NOTE        See `LICENSE' for full license.
##              See `README.md' for project details.
##
################################################################################

# Parser settings.
cff-version: 1.2.0
message: Please cite this software using these meta data.

# Version information.
date-released: 2023-03-06
version: 0.2.3

# Project information.
abstract: A GitHub Action to create a blank Scriv fragment.
authors:
  - alias: kevinmatthes
    family-names: Matthes
    given-names: Kevin
license: GPL-3.0
repository-code: https://github.com/kevinmatthes/create-scriv-fragment
title: create-scriv-fragment
url: https://github.com/kevinmatthes/create-scriv-fragment

################################################################################

GitHub Events

Total
  • Delete event: 4
  • Issue comment event: 1
  • Push event: 3
  • Pull request review event: 3
  • Pull request event: 9
  • Create event: 5
Last Year
  • Delete event: 4
  • Issue comment event: 1
  • Push event: 3
  • Pull request review event: 3
  • Pull request event: 9
  • Create event: 5

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 67
  • Total Committers: 3
  • Avg Commits per committer: 22.333
  • Development Distribution Score (DDS): 0.403
Past Year
  • Commits: 15
  • Committers: 1
  • Avg Commits per committer: 15.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
dependabot[bot] 4****] 40
Kevin Matthes 9****s 23
Kevin Matthes 4****] 4

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 0
  • Total pull requests: 68
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 day
  • Total issue authors: 0
  • Total pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.63
  • Merged pull requests: 52
  • Bot issues: 0
  • Bot pull requests: 43
Past Year
  • Issues: 0
  • Pull requests: 10
  • Average time to close issues: N/A
  • Average time to close pull requests: 8 days
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.2
  • Merged pull requests: 6
  • Bot issues: 0
  • Bot pull requests: 10
Top Authors
Issue Authors
Pull Request Authors
  • dependabot[bot] (57)
  • kevinmatthes (25)
Top Labels
Issue Labels
Pull Request Labels
dependencies (57) documentation (12) enhancement (10) github_actions (4) bug (3)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 4
  • Total versions: 7
github actions: kevinmatthes/create-scriv-fragment

A GitHub Action to create a blank Scriv fragment.

  • License: gpl-3.0
  • Status: removed
  • Latest release: v0.2.3
    published over 3 years ago
  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 4
Rankings
Dependent packages count: 0.0%
Dependent repos count: 16.5%
Average: 25.0%
Forks count: 35.1%
Stargazers count: 48.3%
Last synced: over 1 year ago

Dependencies

.github/workflows/ci.yml actions
  • ./ * composite
  • actions/checkout v3.3.0 composite
  • citation-file-format/cffconvert-github-action 2.0.0 composite
.github/workflows/release.yml actions
  • actions/checkout v3.3.0 composite
  • ad-m/github-push-action v0.6.0 composite
  • kevinmatthes/release-bump2version-scriv v0.2.2 composite
.github/workflows/scriv.yml actions
  • ./ * composite
  • actions/checkout v3.3.0 composite
  • ad-m/github-push-action v0.6.0 composite
action.yml actions
  • actions/setup-python v4.5.0 composite
  • fregante/setup-git-user v1.1.0 composite
  • py-actions/py-dependency-install v4.0.0 composite