fair-software / howfairis-github-action Goto Github PK
View Code? Open in Web Editor NEWGitHub Action to analyze a GitHub repository’s compliance with the fair-software.eu recommendations.
License: Apache License 2.0
GitHub Action to analyze a GitHub repository’s compliance with the fair-software.eu recommendations.
License: Apache License 2.0
A suggested @jspaaks to better fit purpose or repo.
let action use docker image from https://hub.docker.com/r/fairsoftware/howfairis/tags?page=1&ordering=last_updated for better speed and more predictable behavior. Also, use a tagged version as opposed to latest/bleeding edge.
In the long run, it would be good if we have a pip-installable command line tool which runs all check scripts and produces a badge (url for the badge).
Currently we're doing 2 things in this repo. We should split off the howfairis
package into its own repo, preferably while retaining github history. I've done that before, so i can do it, but let's first see what PRs we need to merge before splitting.
To reproduce:
howfairis https://github.com/hexatomic/hexatomic
See https://github.com/hexatomic/hexatomic, which is an open repository :).
I would expect to get a checkmark for that.
On https://github.com/fair-software/badge#for-developers it says you can use
# (from project root directory)
docker build -t howfairis .
However this gives a error:
url: .
AssertionError: url should start with https://
Can the documentation be updated to have commands that work?
If Zenodo were added to the list of registries to check against, this would cover an awful lot of "generic" software releases, e.g., those that don't go into any of the language/packaging registries, e.g., if it's distributed as binary/zip.
As far as I can see, there are two ways to achieve this:
isSupplementTo
record for this repo)."metadata": {
"related_identifiers": [
{
"identifier": "https://github.com/this/repo/tree/v1.1",
"relation": "isSupplementTo",
"scheme": "url"
}
Registries listed https://github.com/NLeSC/awesome-research-software-registries need to be (magically) available in a machine readable format.
At the moment all checking scripts run independently, but the results from them need to be integrated into a single object.
We should build a Class which calls the different scripts and integrates the results.
Noticed it here https://github.com/sequgen/sequgen/runs/2182605029?check_suite_focus=true
Apparently, the github action is looking at main branch'es README.rst, because it was deleted on the feature branch and yet it says
It seems you have not yet added the fair-software.eu badge to your README.rst. You can do so by pasting the following snippet:
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.