From 924183b5581a7d35c7c6deeea5f8e2cb692175ee Mon Sep 17 00:00:00 2001 From: Kevin Matthes Date: Mon, 25 Jul 2022 14:37:09 +0200 Subject: [PATCH 1/2] [Enhancement] Add Basic Citation Meta Data --- .github/workflows/cffconvert.yml | 27 +++++++++++++++++++++++++++ CHANGELOG.md | 4 +++- CITATION.cff | 23 +++++++++++++++++++++++ 3 files changed, 53 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/cffconvert.yml create mode 100644 CITATION.cff diff --git a/.github/workflows/cffconvert.yml b/.github/workflows/cffconvert.yml new file mode 100644 index 0000000..80d7f50 --- /dev/null +++ b/.github/workflows/cffconvert.yml @@ -0,0 +1,27 @@ +name: cffconvert + +on: + pull_request: + paths: + - CITATION.cff + push: + paths: + - CITATION.cff + +permissions: + contents: read + +jobs: + validation: + name: validate + runs-on: ubuntu-latest + steps: + - name: checkout + uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b + with: + persist-credentials: false + + - name: cffconvert + uses: citation-file-format/cffconvert-github-action@4cf11baa70a673bfdf9dad0acc7ee33b3f4b6084 + with: + args: "--validate" diff --git a/CHANGELOG.md b/CHANGELOG.md index 739efc6..e827206 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,8 @@ format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). configuration file [#33](https://github.com/zee-editor/zee/pull/33) - Added a changelog to be updated timely as PRs are merged [#49](https://github.com/zee-editor/zee/pull/49) +- Add basic citation meta data + [#61](https://github.com/zee-editor/zee/discussions/61) ### Fixed @@ -29,7 +31,7 @@ format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). - Fix tree sitter spans not being aligned with text after saving [#65](https://github.com/zee-editor/zee/pull/65) -## v0.3.2 - 2022-04-23 +## 0.3.2 - 2022-04-23 TODO: write changelog entries for all released versions of zee diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..dc54d3c --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,23 @@ +abstract: A modern text editor for the terminal written in Rust. +authors: + - alias: mcobzarenco + family-names: Cobzarenco + given-names: Marius + - alias: iainh + given-names: Iain + - alias: kevinmatthes + family-names: Matthes + given-names: Kevin + - alias: KSXGitHub + - name: The Zee Community +cff-version: 1.2.0 +date-released: 2022-04-23 +message: Please cite this software using these meta data. +license: + - Apache-2.0 + - MIT +repository-artifact: https://crates.io/crates/zee +repository-code: https://github.com/zee-editor/zee +title: zee +url: https://github.com/zee-editor/zee +version: 0.3.2 From 0267fca265f5f593c23ffc1c6a6b0bd57355540a Mon Sep 17 00:00:00 2001 From: Kevin Matthes <92332892+kevinmatthes@users.noreply.github.com> Date: Wed, 27 Jul 2022 20:32:25 +0200 Subject: [PATCH 2/2] Revert CHANGELOG entry, see #73 --- CHANGELOG.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e827206..739efc6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,8 +19,6 @@ format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). configuration file [#33](https://github.com/zee-editor/zee/pull/33) - Added a changelog to be updated timely as PRs are merged [#49](https://github.com/zee-editor/zee/pull/49) -- Add basic citation meta data - [#61](https://github.com/zee-editor/zee/discussions/61) ### Fixed @@ -31,7 +29,7 @@ format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). - Fix tree sitter spans not being aligned with text after saving [#65](https://github.com/zee-editor/zee/pull/65) -## 0.3.2 - 2022-04-23 +## v0.3.2 - 2022-04-23 TODO: write changelog entries for all released versions of zee