Prepare for public release on Gitea: simurgarray package names, community files, Gitea templates, pseudonymised P6 probe names
This commit is contained in:
1 parent
7b13720a4f
commit
dc8a5361fb
23 files changed
+309
-30
No files matched your search
@@ -10,7 +10,7 @@ Publishing code is easy. Publishing it responsibly is a checklist. This post is
|
||||
|
||||
By public I mean four things:
|
||||
|
||||
1. The source code on a public host, with issues and pull requests open.
|
||||
1. The source code on my own Gitea server, open to everyone, with issues and pull requests open.
|
||||
2. Installable packages: a Python wheel, the optional Rust kernel wheels, a container image and a conda recipe.
|
||||
3. Documentation someone can follow without asking me anything.
|
||||
4. A citable record: a DOI for each release and a short preprint describing the methods and the validation.
|
||||
@@ -33,7 +33,7 @@ The same goes for secrets. The cloud scripts use credentials from the local envi
|
||||
|
||||
The software reads file formats defined by Illumina and reproduces the behaviour of Illumina's algorithms from public documents and expired patents. Illumina, Infinium, GenCall, GenTrain and GenomeStudio are their trademarks. The documentation will say clearly that SimurgArray is independent and not affiliated with or endorsed by the vendor, and it will use those names only to describe compatibility.
|
||||
|
||||
The name SimurgArray itself needs a check on the Python package index, conda channels and container registries before anything is uploaded. If someone else has it, I will be sad for a day and then pick a variant.
|
||||
The name needed a check on the Python package index, conda channels and container registries before anything is uploaded. It turned out `simurg` on the Python package index already belongs to someone else, so the package is called `simurgarray` while the command stays `simurg`. I was sad for about an hour, which is less than I had budgeted.
|
||||
|
||||
### Third party data sources
|
||||
|
||||
@@ -51,7 +51,7 @@ Every README, report header and PGx output will state that the software is for r
|
||||
|
||||
### Engineering hygiene
|
||||
|
||||
* Continuous integration on public runners for x86_64 and aarch64: lint, type checks, unit tests.
|
||||
* Continuous integration on my own Gitea runner: lint, type checks, a secret scan, and unit tests with and without the compiled kernels.
|
||||
* Oracle tests that need large public datasets stay opt in, with a script that downloads everything with checksums.
|
||||
* Issue templates that ask for the command, the software version and the run manifest, because "it gave a wrong genotype" is hard to debug without them.
|
||||
* A contributing guide, a code of conduct and a security policy.
|
||||
@@ -73,7 +73,7 @@ The weeks start on Mondays. Everything below costs nothing except time, apart fr
|
||||
Full history scan for vendor files and secrets. Credential rotation. Provenance pass over ported code. Trademark and disclaimer text in README, user guide and report templates.
|
||||
|
||||
**Week of October 12: public repository**
|
||||
Public mirror on a mainstream code host, continuous integration for both architectures, issue templates, contributing guide, code of conduct, security policy. The private Git server stays as my working copy.
|
||||
Open the repository to everyone on my own Gitea server, where it has lived since the first commit, with continuous integration, issue templates, a contributing guide, a code of conduct and a security policy. No mirror elsewhere: one home is easier to keep honest.
|
||||
|
||||
**Week of October 19: packages**
|
||||
Check name availability. Upload version 2.0.0 wheels to the Python package index, the image to a public container registry, and submit the conda recipe for review.
|
||||
|
||||
Reference in new issue
Block a user