Skip to content

Commit

Permalink
Renamed the repository to be more specific about its role.
Browse files Browse the repository at this point in the history
  • Loading branch information
LTLA committed Feb 21, 2024
1 parent ec66569 commit e83b46a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Bioconductor metadata index

[![RunTests](https://github.com/ArtifactDB/gypsum-to-sqlite/actions/workflows/run-tests.yaml/badge.svg)](https://github.com/ArtifactDB/gypsum-to-sqlite/actions/workflows/run-tests.yaml)
[![Updates](https://github.com/ArtifactDB/gypsum-to-sqlite/actions/workflows/update-indices.yaml/badge.svg)](https://github.com/ArtifactDB/gypsum-to-sqlite/actions/workflows/update-indices.yaml)
[![RunTests](https://github.com/ArtifactDB/bioconductor-metadata-index/actions/workflows/run-tests.yaml/badge.svg)](https://github.com/ArtifactDB/bioconductor-metadata-index/actions/workflows/run-tests.yaml)
[![Updates](https://github.com/ArtifactDB/bioconductor-metadata-index/actions/workflows/update-indices.yaml/badge.svg)](https://github.com/ArtifactDB/bioconductor-metadata-index/actions/workflows/update-indices.yaml)

## Overview

Expand All @@ -23,7 +23,7 @@ The name of the metadata document determines the database into which it is inser
- Files named `_bioconductor.json` should validate against the [Bioconductor metadata schema](schemas/bioconductor/v1.json).
These are compiled into the `bioconductor.sqlite3` file.

Package developers may open a [pull request](https://github.com/ArtifactDB/gypsum-to-sqlite) on this repository to add application-specific metadata.
Package developers may open a [pull request](https://github.com/ArtifactDB/bioconductor-metadata-index) on this repository to add application-specific metadata.
This can involve either:

- Adding an application-specific subschema to the `schemas/bioconductor/MY_APP_HERE` subdirectory.
Expand All @@ -40,12 +40,12 @@ Developers adding entirely new schemas should udpate [`merge.sh`](merge.sh) to e

The various GitHub Actions in this repository will publish the SQLite files as release assets.

- The [`fresh-build` Action](https://github.com/ArtifactDB/gypsum-to-sqlite/actions/workflows/fresh-build.yaml) will run the `fresh.sh` script to create and publish a fresh build.
- The [`fresh-build` Action](https://github.com/ArtifactDB/bioconductor-metadata-index/actions/workflows/fresh-build.yaml) will run the `fresh.sh` script to create and publish a fresh build.
This is manually triggered and can be used on the rare occasions where the existing release is irrecoverably out of sync with the **gypsum** bucket.
- The [`update-indices` Action](https://github.com/ArtifactDB/gypsum-to-sqlite/actions/workflows/update-indices.yaml) runs the `update.sh` script daily to match changes to the bucket contents.
- The [`update-indices` Action](https://github.com/ArtifactDB/bioconductor-metadata-index/actions/workflows/update-indices.yaml) runs the `update.sh` script daily to match changes to the bucket contents.
This will only publish a new release if any changes were performed.
- Note that cron jobs in GitHub Actions require some semi-routine nudging to indicate that the repository is still active, otherwise the workflow is disabled.

The latest version of the SQLite files are available [here](https://github.com/ArtifactDB/gypsum-to-sqlite/releases/tag/latest).
The latest version of the SQLite files are available [here](https://github.com/ArtifactDB/bioconductor-metadata-index/releases/tag/latest).
The `modified` file contains the Unix timestamp for the last update of the files;
clients can check this file to determine whether local caches need to be refreshed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"private": true,
"name": "gypsum-to-sqlite",
"name": "bioconductor-metadata-index",
"version": "1.0.0",
"type": "module",
"description": "Index Bioconductor-related metadata from the gypsum backend",
Expand Down

0 comments on commit e83b46a

Please sign in to comment.