kevinmatthes/release-bump2version-scriv
A GitHub Action to prepare a release using bump2version and Scriv.
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.5%) to scientific vocabulary
Keywords from Contributors
Repository
A GitHub Action to prepare a release using bump2version and Scriv.
Basic Info
- Host: GitHub
- Owner: kevinmatthes
- License: gpl-3.0
- Default Branch: main
- Size: 125 KB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
- Releases: 0
Metadata Files
README.md
release-bump2version-scriv
Summary
A GitHub Action to prepare a release using bump2version and Scriv.
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/.
Description
This GitHub Action will prepare a new release using bump2version and Scriv. The former will increment the version numbers as specified, the latter will assemble the CHANGELOG based on both the stored fragments as well as its settings. The user creating the corresponding commit 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.
This Action does not produce any output. For information on the possible inputs, see Inputs.
The branding settings (green background colour with the symbol settings as
icon) were chosen due to the default use case of this Action. The settings icon
symbolises the prerequisites for a new release this Action will take care about.
The colour green is often associated with the season spring which also
symbolises the beginning of something new; here, it is the release which is
going to be prepared.
To apply this Action, just add the following lines to the step section of a GitHub Action workflow job. It is assumed that there is an input named "release", storing the increment level for bump2version.
yaml
- uses: kevinmatthes/release-bump2version-scriv@v0.2.3
with:
release: ${{ inputs.release }}
Inputs
cff
This optional information controls whether there is a CITATION.cff in the
repository root to be updated on release. Allowed values are true and
false.
In case that the given value neither equals true nor false, the Action will
fail with exit code 64. This is the code for wrong user input according to
sysexits.h.
As it is recommended to configure a CITATION.cff, the default value is true,
if omitted.
release
This is a required information. It is the increment level to be passed to bump2version. It is highly recommended to ensure that the value which is given in this field matches the configured increment levels of the respective repository calling this Action in a workflow.
Owner
- Name: Kevin Matthes
- Login: kevinmatthes
- Kind: user
- Repositories: 16
- Profile: https://github.com/kevinmatthes
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 prepare a release using bump2version and Scriv.
authors:
- alias: kevinmatthes
family-names: Matthes
given-names: Kevin
license: GPL-3.0
repository-code: https://github.com/kevinmatthes/release-bump2version-scriv
title: release-bump2version-scriv
url: https://github.com/kevinmatthes/release-bump2version-scriv
################################################################################
GitHub Events
Total
- Delete event: 5
- Issue comment event: 2
- Push event: 2
- Pull request review event: 3
- Pull request event: 12
- Create event: 7
Last Year
- Delete event: 5
- Issue comment event: 2
- Push event: 2
- Pull request review event: 3
- Pull request event: 12
- Create event: 7
Committers
Last synced: about 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| dependabot[bot] | 4****] | 48 |
| Kevin Matthes | 9****s | 23 |
| Kevin Matthes | 4****] | 3 |
Issues and Pull Requests
Last synced: 8 months ago
All Time
- Total issues: 0
- Total pull requests: 76
- Average time to close issues: N/A
- Average time to close pull requests: about 21 hours
- Total issue authors: 0
- Total pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.72
- Merged pull requests: 55
- Bot issues: 0
- Bot pull requests: 52
Past Year
- Issues: 0
- Pull requests: 10
- Average time to close issues: N/A
- Average time to close pull requests: 5 days
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.1
- Merged pull requests: 6
- Bot issues: 0
- Bot pull requests: 10
Top Authors
Issue Authors
- dependabot[bot] (1)
Pull Request Authors
- dependabot[bot] (62)
- kevinmatthes (24)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
- Total downloads: unknown
- Total dependent packages: 0
- Total dependent repositories: 4
- Total versions: 7
github actions: kevinmatthes/release-bump2version-scriv
A GitHub Action to prepare a release using bump2version and Scriv.
- License: gpl-3.0
-
Latest release: v0.2.3
published about 3 years ago
Rankings
Dependencies
- ./ * composite
- actions/checkout v3.3.0 composite
- citation-file-format/cffconvert-github-action 2.0.0 composite
- ./ * composite
- actions/checkout v3.3.0 composite
- ad-m/github-push-action v0.6.0 composite
- actions/checkout v3.3.0 composite
- ad-m/github-push-action v0.6.0 composite
- kevinmatthes/create-scriv-fragment v0.2.1 composite
- actions/setup-python v4.5.0 composite
- fregante/setup-git-user v1.1.0 composite
- kevinmatthes/cff-release-today v0.2.1 composite
- py-actions/py-dependency-install v4.0.0 composite