Skip to content

Commit

Permalink
Merge pull request #4752 from kevinmatthes/feature/cff
Browse files Browse the repository at this point in the history
[Documentation] Create CITATION.cff
  • Loading branch information
epage committed Mar 9, 2023
2 parents 8469554 + b8021a2 commit c7e929e
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 1 deletion.
14 changes: 13 additions & 1 deletion .github/workflows/ci.yml
Expand Up @@ -13,7 +13,7 @@ jobs:
permissions:
contents: none
name: CI
needs: [test, check, docs, rustfmt, clippy]
needs: [test, check, docs, rustfmt, clippy, cffconvert]
runs-on: ubuntu-latest
steps:
- name: Done
Expand Down Expand Up @@ -187,3 +187,15 @@ jobs:
run: make clippy-full
- name: Lint (release)
run: make clippy-release
cffconvert:
name: cffconvert
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
with:
persist-credentials: false
- name: CFF validation
uses: citation-file-format/cffconvert-github-action@2.0.0
with:
args: --validate
22 changes: 22 additions & 0 deletions CITATION.cff
@@ -0,0 +1,22 @@
# Parser settings.
cff-version: 1.2.0
message: Please cite this crate using these information.

# Version information.
date-released: 2023-02-28
version: 4.1.8

# Project information.
abstract: A full featured, fast Command Line Argument Parser for Rust
authors:
- alias: kbknapp
family-names: Knapp
given-names: Kevin B.
- name: The Clap Community
license:
- Apache-2.0
- MIT
repository-artifact: https://crates.io/crates/clap
repository-code: https://github.com/clap-rs/clap
title: clap
url: https://docs.rs/clap
2 changes: 2 additions & 0 deletions Cargo.toml
Expand Up @@ -57,6 +57,8 @@ pre-release-replacements = [
{file="CHANGELOG.md", search="ReleaseDate", replace="{{date}}", min=1},
{file="CHANGELOG.md", search="<!-- next-header -->", replace="<!-- next-header -->\n## [Unreleased] - ReleaseDate\n", exactly=1},
{file="CHANGELOG.md", search="<!-- next-url -->", replace="<!-- next-url -->\n[Unreleased]: https://github.com/clap-rs/clap/compare/{{tag_name}}...HEAD", exactly=1},
{file="CITATION.cff", search="^date-released: ....-..-..", replace="date-released: {{date}}"},
{file="CITATION.cff", search="^version: .+\\..+\\..+", replace="version: {{version}}"},
]

[features]
Expand Down

0 comments on commit c7e929e

Please sign in to comment.