Skip to content

Commit 0d94e79

Browse files
committed
Update README.md
1 parent be291a6 commit 0d94e79

File tree

1 file changed

+2
-78
lines changed

1 file changed

+2
-78
lines changed

README.md

Lines changed: 2 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,2 @@
1-
# data-manager-job-template
2-
3-
![Data Manager Job: 2021.1](https://img.shields.io/badge/data%20manager%20job-2021.1-000000?labelColor=dc332e)
4-
5-
```
6-
FORK THIS REPOSITORY
7-
AND REPLACE THE FOLLOWING
8-
WITH YOUR OWN README/JOB DOCUMENTATION
9-
```
10-
11-
![Architecture](https://img.shields.io/badge/architecture-amd64%20%7C%20arm64-lightgrey)
12-
13-
[![build](https://github.com/InformaticsMatters/data-manager-job-template/actions/workflows/build.yaml/badge.svg)](https://github.com/InformaticsMatters/data-manager-job-template/actions/workflows/build.yaml)
14-
[![publish-tag](https://github.com/InformaticsMatters/data-manager-job-template/actions/workflows/publish-tag.yaml/badge.svg)](https://github.com/InformaticsMatters/data-manager-job-template/actions/workflows/publish-tag.yaml)
15-
[![publish-stable](https://github.com/InformaticsMatters/data-manager-job-template/actions/workflows/publish-stable.yaml/badge.svg)](https://github.com/InformaticsMatters/data-manager-job-template/actions/workflows/publish-stable.yaml)
16-
17-
![GitHub](https://img.shields.io/github/license/informaticsmatters/data-manager-job-template)
18-
19-
![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/informaticsmatters/data-manager-job-template)
20-
21-
A GitHub Template Repository that you can [use] for Data Manager Job
22-
implementations.
23-
24-
This repository is a minimal template for Data Manager Jobs. Although it contains
25-
scaffolding to test and build a Python-based Job, including GitHub actions to
26-
build and publish the implementation container image you can replace the
27-
`src` files and associated `Dockerfile` to support any language you choose.
28-
Ultimately the Job is published as a container image, you simply have to
29-
provide the implementation and a suitable `data-manager/jobs.yaml`
30-
definition.
31-
32-
From a fork you should be able to build and run the tests for the example
33-
Job that it defines, start with this, and you'll know you're starting with
34-
a working framework: -
35-
36-
python -m venv venv
37-
source venv/bin/activate
38-
python -m pip install -r build-requirements.txt
39-
40-
docker-compose build
41-
jote
42-
43-
deactivate
44-
45-
> Note: You MUST provide at least one test for every Job your repository
46-
defines, and you MUST use our Job Tester ([im-jote]) to run those tests -
47-
it's what we will use and if it fails the Job Tester we are unlikely
48-
to deploy the image.
49-
50-
You must have at least one manifest file and at least one job definition file.
51-
This template contains a single working example.
52-
53-
As well as replacing this README with your own you will want to
54-
adjust the following additional files: -
55-
56-
1. `DEVELOPER-READEM.md` to name the repository you've forked to
57-
2. `data-manager/manifest.yaml`
58-
3. `data-manager/job.yaml`
59-
4. The GitHub Actions, which expects repository secrets `DOCKERHUB_USERNAME`
60-
and `DOCKERHUB_TOKEN`
61-
5. Adjust the `.gitignore` to satisfy your won tooling
62-
6. Add tests (and test data)
63-
64-
## ARM64 (M1) processor support
65-
To assist in local execution on the ARM64 (Apple M1) series of processors
66-
your job container image must compile for its architecture. The GitHub actions
67-
supplied in this template do that for you by employing the Docker [buildx]
68-
actions.
69-
70-
You can test that your intended mage builds for the ARM64 processor using the
71-
notes in this public [buildx gist].
72-
73-
---
74-
75-
[buildx]: https://docs.docker.com/buildx/working-with-buildx
76-
[buildx gist]: https://gist.github.com/alanbchristie/14da3444f3fed6f0adcf877a82b56804.js
77-
[im-jote]: https://pypi.org/project/im-jote
78-
[use]: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template
1+
# Free AI at api.airforce
2+
https://discord.gg/AJDsM7jtbq

0 commit comments

Comments
 (0)