[Enhancement] Add CITATION.cff, Linters, and Maintain CI (#3)

* Create CITATION.cff

* Add linters for CFF and CI; reduce permissions
main
Kevin Matthes 2023-07-12 19:56:38 +02:00 committed by GitHub
parent 63abe3e3b5
commit 5a3e958ae1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 45 additions and 1 deletions

View File

@ -8,7 +8,23 @@ on:
schedule:
- cron: '0 0 * * 4'
permissions:
contents: read
jobs:
actionlint:
runs-on: ubuntu-latest
steps:
- name: Checkout ${{ github.repository }}
uses: actions/checkout@v3
with:
persist-credentials: false
- name: Lint CI
uses: docker://rhysd/actionlint:latest
with:
args: -color
build:
strategy:
matrix:
@ -21,8 +37,10 @@ jobs:
with:
stable: true
- name: Checkout ${{ github.event.repository.name }}
- name: Checkout ${{ github.repository }}
uses: actions/checkout@v3
with:
persist-credentials: false
- name: Check if code is formatted
run: |
@ -34,3 +52,16 @@ jobs:
- name: Run Tests
run: v test .
cffconvert:
runs-on: ubuntu-latest
steps:
- name: Checkout ${{ github.repository }}
uses: actions/checkout@v3
with:
persist-credentials: false
- name: Lint CITATION.cff
uses: docker://citationcff/cffconvert:latest
with:
args: --validate

13
CITATION.cff Normal file
View File

@ -0,0 +1,13 @@
abstract: A sample CLI tool made in V that prints geometric shapes to the screen.
authors:
- alias: hungrybluedev
family-names: Haldar
given-names: Subhomoy
cff-version: 1.2.0
date-released: 2023-04-20
license: MIT
message: Please cite this software using these information.
repository-code: https://github.com/hungrybluedev/geo
title: geo
url: https://github.com/hungrybluedev/geo
version: 0.2.4