Data

Tools

Indexes

Applications

Experiments

Open Source Science

cff-release-today

Set the release date of the CITATION.cff to the present day.

https://github.com/kevinmatthes/cff-release-today

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.4%) to scientific vocabulary

Keywords from Contributors

hack meshing standardization interpretability pipeline-testing bridges datacleaner data-profilers robust pinn
Last synced: 8 months ago · JSON representation ·

Repository

Set the release date of the CITATION.cff to the present day.

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

README.md

cff-release-today

Summary

Set the release date of the CITATION.cff to the present day.

  1. License
  2. Description
  3. Inputs
    1. checkout
    2. commit
    3. push
    4. validate
  4. 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) 2022─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 set the entry of the field date-released in the top-level scope of a CITATION.cff to the present day. The present day is thereby determined by the locale settings of the runner executing this Action.

The field to be updated needs to match the following regular expression.

^date-release: ....-..-..

Thus, the date must not be enclosed in neither single nor double quotes and must be separated from the field's name by exactly one space character.

It is recommended to execute this Action on a Linux runner as tests have shown that the required applications are available out-of-the-box on GitHub's default Linux runner. This Action requires a Bash shell environment. There are no ouputs.

This Action only operates on the file named CITATION.cff, stored in the respective repository's root directory. It will succeed even if there is no date-released field given in the top-level scope of the CITATION.cff to work on but it will fail if there is no CITATION.cff in the root directory of the respective repository.

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

yaml - uses: kevinmatthes/cff-release-today@v0.5.2

Inputs

checkout

This input is optional. When set to true, the repository to work will be checked out automatically before operating on it. This option is set to false, by default.

commit

This input is optional. When set to true, the changes to the CITATION.cff will be committed after the Git identity was set to the GitHub Actions bot. This option is set to false, by default.

push

This input is optional. When set to true, the changes to the CITATION.cff will be committed and pushed to the respective repository. This option overrides the settings for checkout and commit. This option is set to false, by default.

validate

This input is optional. When set to true, the CITATION.cff will be checked for validity before being updated. This option is set to true, by default.

Branding Information

The branding of this Aciton uses the icon sunrise on a green background. The sunrise shall symbolise the "dawn" of a new version. The colour green was chosen as it is often associated with the season spring which, again, stands for the beginning of something new.

Owner

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

Citation (CITATION.cff) 

######################## GNU General Public License 3.0 ########################
##                                                                            ##
## Copyright (C) 2022─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        2022─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.5.2

# Project information.
abstract: Set the release date of the CITATION.cff to the present day.
authors:
  - alias: kevinmatthes
    family-names: Matthes
    given-names: Kevin
license: GPL-3.0
repository-code: https://github.com/kevinmatthes/cff-release-today
title: cff-release-today
url: https://github.com/kevinmatthes/cff-release-today

# References.
references:
  - type: software
    abstract: CITATION.cff files are plain text files with human- and machine-readable citation information for software. Code developers can include them in their repositories to let others know how to correctly cite their software. This is the specification for the Citation File Format.
    authors:
      - family-names: Druskat
        given-names: Stephan
        orcid: https://orcid.org/0000-0003-4925-7248
      - family-names: Spaaks
        given-names: Jurriaan H.
        orcid: https://orcid.org/0000-0002-7064-4069
      - family-names: Chue Hong
        given-names: Neil
        orcid: https://orcid.org/0000-0002-8876-7606
      - family-names: Haines
        given-names: Robert
        orcid: https://orcid.org/0000-0002-9538-7919
      - family-names: Baker
        given-names: James
        orcid: https://orcid.org/0000-0002-2682-6922
      - family-names: Bliven
        given-names: Spencer
        orcid: https://orcid.org/0000-0002-1200-1698
        email: spencer.bliven@gmail.com
      - family-names: Willighagen
        given-names: Egon
        orcid: https://orcid.org/0000-0001-7542-0286
      - family-names: Pérez-Suárez
        given-names: David
        orcid: https://orcid.org/0000-0003-0784-6909
        website: https://dpshelio.github.io
      - family-names: Konovalov
        given-names: Alexander
        orcid: https://orcid.org/0000-0001-5299-3292
    title: Citation File Format
    version: 1.2.0
    identifiers:
      - type: doi
        value: 10.5281/zenodo.1003149
        description: The concept DOI for the collection containing all versions of the Citation File Format.
      - type: doi
        value: 10.5281/zenodo.5171937
        description: The versioned DOI for the version 1.2.0 of the Citation File Format.
    date-released: "2021-08-09"
    keywords:
      - citation file format
      - CFF
      - citation files
      - software citation
      - file format
      - YAML
      - software sustainability
      - research software
      - credit
    license: "CC-BY-4.0"
    doi: 10.5281/zenodo.5171937
  - type: software
    authors:
      -
        family-names: Spaaks
        given-names: "Jurriaan H."
        orcid: "https://orcid.org/0000-0002-7064-4069"
      -
        family-names: Diblen
        given-names: Faruk
        orcid: "https://orcid.org/0000-0002-0989-929X"
      -
        family-names: "Soares Siqueira"
        given-names: Abel
        orcid: "https://orcid.org/0000-0003-4451-281X"
    date-released: 2022-01-24
    identifiers:
      - type: doi
        value: 10.5281/zenodo.3993241
        description: "The work's conceptdoi"
    license: "Apache-2.0"
    title: "cffconvert GitHub Action"
    version: 2.0.0
  - type: software
    abstract: GitHub Action that sets the git user and email to enable commiting
    authors:
      - alias: fregante
        email: me@fregante.com
        family-names: Brigante
        given-names: Federico
        website: https://fregante.com
    date-released: 2023-02-28
    license: MIT
    repository-code: https://github.com/fregante/setup-git-user
    title: setup-git-user
    url: https://github.com/fregante/setup-git-user
    version: 2.0.0

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

GitHub Events

Total
  • Delete event: 1
  • Push event: 1
  • Pull request review event: 1
  • Pull request event: 2
  • Create event: 1
Last Year
  • Delete event: 1
  • Push event: 1
  • Pull request review event: 1
  • Pull request event: 2
  • Create event: 1

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 71
  • Total Committers: 3
  • Avg Commits per committer: 23.667
  • Development Distribution Score (DDS): 0.521
Past Year
  • Commits: 10
  • Committers: 1
  • Avg Commits per committer: 10.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
dependabot[bot] 4****] 34
Kevin Matthes 9****s 31
Kevin Matthes 4****] 6

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 72
  • Average time to close issues: N/A
  • Average time to close pull requests: about 12 hours
  • Total issue authors: 0
  • Total pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.9
  • Merged pull requests: 48
  • Bot issues: 0
  • Bot pull requests: 36
Past Year
  • Issues: 0
  • Pull requests: 9
  • Average time to close issues: N/A
  • Average time to close pull requests: about 8 hours
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 9
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • dependabot[bot] (45)
  • kevinmatthes (35)
Top Labels
Issue Labels
Pull Request Labels
dependencies (45) documentation (19) enhancement (14) github_actions (3) bug (2)

Dependencies

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