Skip to content

Commit 14f90a9

Browse files
authored
Merge pull request #261 from datalad/enh-README
doc: clarify that we are potentially providing builds of modified git-annex
2 parents 995f177 + b47d58c commit 14f90a9

1 file changed

Lines changed: 56 additions & 10 deletions

File tree

README.md

Lines changed: 56 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,57 @@
1-
This is a mirror of the official [git-annex](https://git-annex.branchable.com)
2-
repository at <https://git.kitenet.net/index.cgi/git-annex.git/>. The remote
3-
`master` branch is mirrored here as
4-
[`upstream/master`](https://github.com/datalad/git-annex/tree/upstream/master).
5-
The local `master` branch in this repository is only used to store CI
6-
configuration and associated scripts.
1+
# datalad/git-annex
72

8-
## Submitting Patches
3+
## The purpose
4+
5+
### Downstream testing
6+
7+
The primary goal for the repository is to provide extensive automated testing
8+
of fresh builds of [git-annex](https://git-annex.branchable.com) using
9+
its built-in test battery across various base operating systems and
10+
environments, and against our downstream [DataLad](https://datalad.org/)
11+
project.
12+
13+
### Distribution
14+
15+
As a side-artifact of the build during the testing process, we provide non-official
16+
automated builds of `git-annex`. They are attached as artifacts to the CI
17+
runs, and, for the `git-annex` releases, also to the
18+
[Releases](https://github.com/datalad/git-annex/releases) page. All build logs
19+
and builds are archived "privately" on an internal server using
20+
[con/tinuous](https://github.com/con/tinuous), and release builds are then
21+
re-shared from the
22+
[///datalad/packages](https://datasets.datalad.org/?dir=/datalad/packages)
23+
DataLad package.
24+
25+
These builds are **non-official** builds of
26+
[git-annex](https://git-annex.branchable.com) and their functioning might
27+
differ from the official builds.
28+
29+
## AI Disclaimer
30+
31+
Agentic AI tools might be used for various aspects of the
32+
troubleshooting, development, and maintenance in this repository. We
33+
strive to provide our best effort for adequate provenance and attribution on
34+
AI-assisted work in commit messages, patch headers, and issues.
35+
36+
## Structure and workflow
37+
38+
### Branches
39+
40+
This repository contains two primary branches:
41+
42+
- [`upstream/master`](https://github.com/datalad/git-annex/tree/upstream/master) -
43+
an unmodified mirror of the `master` branch from the original
44+
[git-annex](https://git-annex.branchable.com) [repository](https://git.kitenet.net/index.cgi/git-annex.git/), and
45+
- [`master`](https://github.com/datalad/git-annex/tree/master) -
46+
CI configuration, associated scripts, and potential patches on top of `upstream/master`,
47+
which are then applied at build time.
48+
49+
As a result, the builds provided here may function differently
50+
than the official original builds of git-annex. This repository also contains
51+
issues which might be specific to these builds and not necessarily relevant
52+
to the original git-annex.
53+
54+
### Submitting Patches
955

1056
Patches to the git-annex source code can be added by opening a pull request
1157
against `master` that adds a Git patch file with a `.patch` file extension to
@@ -29,21 +75,21 @@ will fail.
2975

3076
[![Update mirror](https://github.com/datalad/git-annex/actions/workflows/update-mirror.yml/badge.svg)](https://github.com/datalad/git-annex/actions/workflows/update-mirror.yml)
3177

32-
## Build git-annex & test DataLad against it
78+
### Build git-annex & test DataLad against it
3379

3480
[![Ubuntu](https://github.com/datalad/git-annex/actions/workflows/build-ubuntu.yaml/badge.svg)](https://github.com/datalad/git-annex/actions/workflows/build-ubuntu.yaml)
3581
[![macOS](https://github.com/datalad/git-annex/actions/workflows/build-macos.yaml/badge.svg)](https://github.com/datalad/git-annex/actions/workflows/build-macos.yaml)
3682
[![Windows](https://github.com/datalad/git-annex/actions/workflows/build-windows.yaml/badge.svg)](https://github.com/datalad/git-annex/actions/workflows/build-windows.yaml)
3783

38-
## Client Tests
84+
### Client Tests
3985

4086
| Client | Test Status |
4187
| --- | --- |
4288
| [openmind7](https://datalad.github.io/git-annex-ci-reports/#openmind7) | ![Overall test status](https://github.com/datalad/git-annex-ci-client-jobs/raw/master/badges/openmind7.svg) ![git-annex-home test status](https://github.com/datalad/git-annex-ci-client-jobs/raw/master/badges/openmind7/git-annex-home.svg) ![git-annex-om2 test status](https://github.com/datalad/git-annex-ci-client-jobs/raw/master/badges/openmind7/git-annex-om2.svg) |
4389
| [ndoli](https://datalad.github.io/git-annex-ci-reports/#ndoli) | ![Overall test status](https://github.com/datalad/git-annex-ci-client-jobs/raw/master/badges/ndoli.svg) ![git-annex-home test status](https://github.com/datalad/git-annex-ci-client-jobs/raw/master/badges/ndoli/git-annex-home.svg) ![git-annex-tmp test status](https://github.com/datalad/git-annex-ci-client-jobs/raw/master/badges/ndoli/git-annex-tmp.svg) |
4490
| [smaug](https://datalad.github.io/git-annex-ci-reports/#smaug) | ![Overall test status](https://github.com/datalad/git-annex-ci-client-jobs/raw/master/badges/smaug.svg) ![git-annex test status](https://github.com/datalad/git-annex-ci-client-jobs/raw/master/badges/smaug/git-annex.svg) |
4591

46-
## Builds of whls for PyPI (by @psychoinformatics-de)
92+
### Builds of whls for PyPI (by @psychoinformatics-de)
4793

4894
[![Linux](https://github.com/psychoinformatics-de/git-annex-wheel/actions/workflows/build-linux.yaml/badge.svg)](https://github.com/psychoinformatics-de/git-annex-wheel/actions/workflows/build-linux.yaml)
4995
[![MacOS (13, Intel)](https://github.com/psychoinformatics-de/git-annex-wheel/actions/workflows/build-macos-intel.yaml/badge.svg)](https://github.com/psychoinformatics-de/git-annex-wheel/actions/workflows/build-macos-intel.yaml)

0 commit comments

Comments
 (0)