🔀 merge: main to staging branch (#60)

* fix: 🐛 metadata url update + collection call correct * fix: 🐛 typo fix and exit workflow on push event if installation does not exist * feat: ✨ add codemeta file * feat: ✨ add citation file * Create CHANGELOG.md * Update README.md * Update README.md --------- Co-authored-by: codefair-app[bot] <165336008+codefair-app[bot]@users.noreply.github.com> Co-authored-by: Bhavesh Patel <b.patel@berkeley.edu>
fairdataihub · Aug 27, 2024 · 75fa2ec · 75fa2ec
1 parent 4a5bd2c
commit 75fa2ec
Show file tree

Hide file tree

Showing 6 changed files with 133 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,14 @@
+# Change Log
+
+All notable changes the Codefair App will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## v1.0.0 - 2024-08-26
+
+### Identifier
+https://doi.org/10.5281/zenodo.13376617
+
+### Added
+- First release with license file and metadata files generating features
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,37 @@
+title: Codefair
+authors:
+  - given-names: Dorian
+    family-names: Portillo
+    email: dportillo@calmi2.org
+    affiliation: FAIR Data Innovations Hub, California Medical Innovations Institute
+  - given-names: Sanjay
+    family-names: Soundarajan
+    email: ssoundarajan@calmi2.org
+    affiliation: FAIR Data Innovations Hub, California Medical Innovations Institute
+  - given-names: Bhavesh
+    family-names: Patel
+    email: bpatel@calmi2.org
+    affiliation: FAIR Data Innovations Hub, California Medical Innovations Institute
+cff-version: 1.2.0
+message: If you use this software, please cite it using the metadata from this file.
+type: software
+identifiers:
+  - type: doi
+    value: https://doi.org/10.5281/zenodo.13376617
+abstract: "Codefair is a free and open source GitHub app that acts as your
+  personal assistant when it comes to making your research software reusable and
+  especially complying with the Findable, Accessible, Interoperable, Reusable
+  (FAIR) Principles for Research Software (FAIR4RS Principles). Whether you are
+  developing artificial intelligence (AI)/machine learning (ML) models with
+  Python, data visualization tools with Jupyter notebook, or data analysis code
+  with R, Codefair is here to assist you. "
+keywords:
+  - best-practices
+  - fair
+  - research
+  - reusable
+  - software
+license: MIT
+repository-code: https://github.com/fairdataihub/codefair-app
+version: 1.0.0
+date-released: 2024-08-26
diff --git a/README.md b/README.md
@@ -32,9 +32,13 @@ Your coding assistant to make research software reusable without breaking a swea
   <a href="https://github.com/fairdataihub/codefair-app/blob/main/LICENSE">
     <img src="https://img.shields.io/github/license/fairdataihub/codefair-app.svg?style=flat-square" alt="license" />
   </a>
-  <a href="https://fairdataihub.org/fairshare">
-    <img src="https://raw.githubusercontent.com/fairdataihub/FAIRshare/main/badge.svg" alt="Curated with FAIRshare" />
+  <a href="https://doi.org/10.5281/zenodo.13376617">
+    <img src="https://zenodo.org/badge/DOI/10.5281/zenodo.13376617.svg" alt="Zenodo DOI" />
   </a>
+  <a href="https://archive.softwareheritage.org/browse/origin/https://github.com/fairdataihub/codefair-app/">
+    <img src="https://archive.softwareheritage.org/badge/origin/https://github.com/fairdataihub/codefair-app/" alt="Software Heritage archive" />
+  </a>
+
 </p>
 
 </div>
@@ -97,15 +101,8 @@ This work is licensed under
 If you are using this package or reusing the source code from this repository for any purpose, please cite:
 
 ```text
-    Coming soon...
+   Portillo, D., Soundarajan, S., & Patel, B., (2024). Codefair App. Zenodo. 10.5281/zenodo.13376617
 ```
-
-## Acknowledgements
-
-```text
-    Coming soon...
-```
-
 <br />
 
 ---

diff --git a/bot/index.js b/bot/index.js
@@ -128,6 +128,7 @@ export default async (app, { getRouter }) => {
           removed_files: [],
         };
 
+        // If existing cwl validation exists, update the contains_cwl value
         // If existing cwl validation exists, update the contains_cwl value
         const cwlExists = await db.collection("cwlValidation").findOne({
           repositoryId: repository.id,
@@ -155,9 +156,8 @@ export default async (app, { getRouter }) => {
 
         // Create an issue with the compliance issues body
         await createIssue(context, owner, repository, ISSUE_TITLE, issueBody);
-      }
-    },
-  );
+    }
+  });
 
   app.on(
     ["installation.deleted", "installation_repositories.removed"],

diff --git a/bot/utils/renderer/index.js b/bot/utils/renderer/index.js
@@ -18,8 +18,6 @@ const CODEFAIR_DOMAIN = process.env.CODEFAIR_APP_DOMAIN;
  * @param {string} owner - The owner of the repository
  * @param {object} repository  - The repository metadata
  * @param {object} prInfo  - The PR information
- * @param {string} prTitle - The title of the PR
- * @param {string} prNumber - The number of the PR
  * @param {string} prLink - The link to the PR
  * @param {array} commits - The commits that were pushed
  *

diff --git a/codemeta.json b/codemeta.json
@@ -0,0 +1,72 @@
+{
+  "name": "Codefair",
+  "@context": "https://w3id.org/codemeta/3.0",
+  "applicationCategory": "Content management software",
+  "author": [
+    {
+      "affiliation": {
+        "name": "FAIR Data Innovations Hub, California Medical Innovations Institute",
+        "type": "Organization"
+      },
+      "email": "dportillo@calmi2.org",
+      "familyName": "Portillo",
+      "id": "_:author_1",
+      "givenName": "Dorian",
+      "type": "Person"
+    },
+    {
+      "affiliation": {
+        "name": "FAIR Data Innovations Hub, California Medical Innovations Institute",
+        "type": "Organization"
+      },
+      "email": "ssoundarajan@calmi2.org",
+      "familyName": "Soundarajan",
+      "id": "_:author_2",
+      "givenName": "Sanjay",
+      "type": "Person"
+    },
+    {
+      "affiliation": {
+        "name": "FAIR Data Innovations Hub, California Medical Innovations Institute",
+        "type": "Organization"
+      },
+      "email": "bpatel@calmi2.org",
+      "familyName": "Patel",
+      "id": "_:author_3",
+      "givenName": "Bhavesh",
+      "type": "Person"
+    }
+  ],
+  "codeRepository": "https://github.com/fairdataihub/codefair-app",
+  "dateCreated": "2024-03-27",
+  "dateModified": "2024-08-26",
+  "datePublished": "2024-08-26",
+  "description": "Codefair is a free and open source GitHub app that acts as your personal assistant when it comes to making your research software reusable and especially complying with the Findable, Accessible, Interoperable, Reusable (FAIR) Principles for Research Software (FAIR4RS Principles). Whether you are developing artificial intelligence (AI)/machine learning (ML) models with Python, data visualization tools with Jupyter notebook, or data analysis code with R, Codefair is here to assist you. ",
+  "developmentStatus": "active",
+  "downloadUrl": "https://github.com/marketplace/codefair-app",
+  "identifier": "https://doi.org/10.5281/zenodo.13376617",
+  "issueTracker": "https://github.com/fairdataihub/codefair-app/issues",
+  "keywords": [
+    "best-practices",
+    "fair",
+    "research",
+    "reusable",
+    "software"
+  ],
+  "license": "https://spdx.org/licenses/MIT",
+  "operatingSystem": [],
+  "programmingLanguage": [
+    "Vue",
+    "JavaScript",
+    "HTML",
+    "TypeScript",
+    "CSS",
+    "Dockerfile"
+  ],
+  "relatedLink": [],
+  "runtimePlatform": [],
+  "schema:releaseNotes": "First release",
+  "softwareRequirements": [],
+  "version": "1.0.0",
+  "type": "SoftwareSourceCode"
+}