Skip to content

Commit

Permalink
Various fixes (#18)
Browse files Browse the repository at this point in the history
* ci: fixed quarto pipeline

* fix: readme and licenses fixed

* chore: dependencies updated to latest

* chore: husky config updated

* ci: labeler conf migrated to v5

* fix: wrong uri fix

* ci: labeler conf migrated to v5

* ci: labeler conf migrated to v5

* ci: labeler conf migrated to v5

* ci: labeler removed due to overcomplicated config

* ci: sveltekitci quickfix

* chore: dependencies updated to latest
  • Loading branch information
maehr authored May 6, 2024
1 parent b1aac62 commit 1229e3c
Show file tree
Hide file tree
Showing 8 changed files with 1,125 additions and 961 deletions.
62 changes: 62 additions & 0 deletions .github/_quarto.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
project:
type: website

website:
title: GitHub template for FAIR and open research data
favicon: android-chrome-512x512.png
open-graph: true
twitter-card: true
site-url: https://maehr.github.io/open-research-data-template/
repo-url: https://github.com/maehr/open-research-data-template/
issue-url: https://github.com/maehr/open-research-data-template/issues/new/choose
repo-actions: [edit, issue]
page-navigation: true
bread-crumbs: true
back-to-top-navigation: true
search:
show-item-context: true
type: overlay
navbar:
logo: android-chrome-512x512.png
logo-alt: ''
title: open-research-data-template
tools:
- icon: github
url: https://github.com/maehr/open-research-data-template/
left:
- text: Readme
href: index.qmd
- text: Report
href: report.md

sidebar:
contents:
- section: open-research-data-template
href: index.qmd
contents:
- text: Changelog
href: CHANGELOG.md
- text: Code of Conduct
href: CODE_OF_CONDUCT.md
- text: Contributing
href: CONTRIBUTING.md
- text: License (Data)
href: LICENSE-CCBY.md
- text: License (Code)
href: LICENSE-AGPL.md
- text: Security
href: SECURITY.md
- href: report.md
contents: project-management/*

format:
html:
toc: true
theme: cosmo
code-copy: true
code-overflow: wrap
css: styles.css

freeze: true

editor: visual
35 changes: 0 additions & 35 deletions .github/labeler.yml

This file was deleted.

12 changes: 0 additions & 12 deletions .github/workflows/label.yml

This file was deleted.

5 changes: 5 additions & 0 deletions .github/workflows/quarto-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ jobs:
- name: Check out repository
uses: actions/checkout@v4

- name: Overwrite _quarto.yml
if: github.repository == 'maehr/open-research-data-template'
run: |
cp .github/_quarto.yml _quarto.yml
- name: Set up Quarto
uses: quarto-dev/quarto-actions/setup@v2
env:
Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ This GitHub template is independent of the (research) data and its format. It fo
[![GitHub issues](https://img.shields.io/github/issues/maehr/open-research-data-template.svg)](https://github.com/maehr/open-research-data-template/issues)
[![GitHub forks](https://img.shields.io/github/forks/maehr/open-research-data-template.svg)](https://github.com/maehr/open-research-data-template/network)
[![GitHub stars](https://img.shields.io/github/stars/maehr/open-research-data-template.svg)](https://github.com/maehr/open-research-data-template/stargazers)
[![GitHub license](https://img.shields.io/github/license/maehr/open-research-data-template.svg)](https://github.com/maehr/open-research-data-template/blob/main/LICENSE.md)
[![Code license](https://img.shields.io/github/license/maehr/open-research-data-template.svg)](https://github.com/maehr/open-research-data-template/blob/main/LICENSE-AGPL.md)
[![Data license](https://img.shields.io/github/license/maehr/open-research-data-template.svg)](https://github.com/maehr/open-research-data-template/blob/main/LICENSE-CCBY.md)

<!-- FIXME [![DOI](https://zenodo.org/badge/ZENODO_RECORD.svg)](https://zenodo.org/badge/latestdoi/ZENODO_RECORD) -->

## Why use a template (even for small datasets)?

Expand All @@ -21,7 +24,7 @@ This GitHub template is independent of the (research) data and its format. It fo

- Citeable via [DOI](https://www.doi.org/) (and [CITATION.cff](https://citation-file-format.github.io/))
- Automatic long-term archiving via [Zenodo](https://zenodo.org/)
- Licensed under a non-restrictive [CC BY 4.0 license](LICENSE.md) according to [The Turing Way](https://the-turing-way.netlify.app/reproducible-research/rdm/rdm-sharing.html#step-3-choose-a-licence-and-link-to-your-paper-and-code)
- Licensed under a non-restrictive [AGPL 3.0](LICENSE-AGPL.md) and [CC BY 4.0](LICENSE-CCBY.md) license according to [The Turing Way](https://the-turing-way.netlify.app/reproducible-research/rdm/rdm-sharing.html#step-3-choose-a-licence-and-link-to-your-paper-and-code)
- Templates for reporting data issues using a [custom template](.github/ISSUE_TEMPLATE/data_issue_report.md)

### Documentation
Expand All @@ -39,7 +42,6 @@ This GitHub template is independent of the (research) data and its format. It fo
- Consistent versioning via [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
- Consistent [fork and pull](https://gist.github.com/Chaser324/ce0505fbed06b947d962) workflow via [GitHub branch protection](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule)
- Consistent issues via [issue templates](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository)
- Consistent pull request labels via [labeler](https://github.com/actions/labeler)
- Consistent file and folder naming conventions via [The Turing Way](https://the-turing-way.netlify.app/reproducible-research/rdm/rdm-storage.html#file-naming-conventions)

### Security
Expand Down
3 changes: 2 additions & 1 deletion README.template.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ This repository contains SHORT_DESCRIPTION. The data in this repository is openl
[![GitHub issues](https://img.shields.io/github/issues/USERNAME/REPO_NAME.svg)](https://github.com/USERNAME/REPO_NAME/issues)
[![GitHub forks](https://img.shields.io/github/forks/USERNAME/REPO_NAME.svg)](https://github.com/USERNAME/REPO_NAME/network)
[![GitHub stars](https://img.shields.io/github/stars/USERNAME/REPO_NAME.svg)](https://github.com/USERNAME/REPO_NAME/stargazers)
[![GitHub license](https://img.shields.io/github/license/USERNAME/REPO_NAME.svg)](https://github.com/USERNAME/REPO_NAME/blob/main/LICENSE.md)
[![Code license](https://img.shields.io/github/license/USERNAME/REPO_NAME.svg)](https://github.com/USERNAME/REPO_NAME/blob/main/LICENSE-AGPL.md)
[![Data license](https://img.shields.io/github/license/USERNAME/REPO_NAME.svg)](https://github.com/USERNAME/REPO_NAME/blob/main/LICENSE-CCBY.md)
[![DOI](https://zenodo.org/badge/ZENODO_RECORD.svg)](https://zenodo.org/badge/latestdoi/ZENODO_RECORD)

## Repository Structure
Expand Down
17 changes: 6 additions & 11 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,24 @@
"url": "https://github.com/USERNAME/REPO_NAME/issues",
"license": "AGPL-3.0",
"scripts": {
"check": "prettier --ignore-path .gitignore --check . '!{CODE_OF_CONDUCT.md,LICENSE.md,_layouts/default.html,package-lock.json,pnpm-lock.yaml,yarn.lock}'",
"check": "prettier --ignore-path .gitignore --check . '!{CODE_OF_CONDUCT.md,LICENSE-AGPL.md,LICENSE-CCBY.md,_layouts/default.html,package-lock.json,pnpm-lock.yaml,yarn.lock}'",
"commit": "cz",
"format": "prettier --ignore-path .gitignore --write . '!{CODE_OF_CONDUCT.md,LICENSE.md,_layouts/default.html,package-lock.json,pnpm-lock.yaml,yarn.lock}'",
"prepare": "husky install",
"format": "prettier --ignore-path .gitignore --write . '!{CODE_OF_CONDUCT.md,LICENSE-AGPL.md,LICENSE-CCBY.md,_layouts/default.html,package-lock.json,pnpm-lock.yaml,yarn.lock}'",
"prepare": "husky",
"changelog": "npm exec git-cliff -- --config cliff.toml"
},
"devDependencies": {
"commitizen": "^4.3.0",
"cz": "^1.8.2",
"cz-conventional-changelog": "^3.3.0",
"git-cliff": "^1.3.1",
"husky": "^8.0.3",
"prettier": "^3.0.3"
"git-cliff": "^2.2.1",
"husky": "^9.0.11",
"prettier": "^3.2.5"
},
"type": "module",
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog"
},
"husky": {
"hooks": {
"prepare-commit-msg": "exec < /dev/tty && git cz --hook || true"
}
}
}
}
Loading

0 comments on commit 1229e3c

Please sign in to comment.