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.

      - 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.