Skip to content

Commit 86a484c

Browse files
committed
package .env file as well
1 parent 6fbf7fa commit 86a484c

File tree

2 files changed

+14
-12
lines changed

2 files changed

+14
-12
lines changed

Makefile

+3-3
Original file line numberDiff line numberDiff line change
@@ -132,11 +132,11 @@ local_save_images:
132132

133133
#@echo "Inspect tarball manifests with";
134134
#tar -xf o2r-reference-implementation-images.tar.gz manifest.json -O | python -m json.tool;
135-
136-
create_archive:
135+
136+
create_archives:
137137
zip -r -q o2r-reference-implementation-modules.zip containerit/ erc-checker/ o2r-*/;
138138
zip -r -q o2r-docs.zip api/ architecture/ erc-examples/ erc-spec/;
139-
zip -r -q o2r-reference-implementation-files.zip etc/ README*.md docker-compose*.yml versions.txt;
139+
zip -r -q o2r-reference-implementation-files.zip etc/ .env docker-compose*.yml LICENSE versions.txt;
140140

141141
versions:
142142
make --version;

README.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -240,22 +240,24 @@ This repository captures all software projects to create a reproduction package,
240240

241241
### Create package
242242

243-
The creation of the reproducibility package consists of the following steps and is relies where possible on Makefile targets.
244-
The package uses the remote images from Docker Hub at the time of creation
243+
The creation of the reproducibility package consists of the following steps and relies on `Makefile` targets where possible (see brackets `(make ...)`).
244+
The package uses the locally built images.
245245

246246
1. Clone the `reference-implementation` repository to an empty directory: `git clone https://github.com/o2r-project/reference-implementation.git`
247-
1. Create the package with `make release`, which...
248-
- cleans up potentially existing artifacts (`make local_clean`),
249-
- prints software versions (`make versions`),
247+
1. Create the package with `make package`, which...
248+
- cleans up existing artifacts (`make package_clean local_clean`),
249+
- prints _used_ software versions (git, Docker etc., `make versions`),
250250
- updates the nested projects (`make update`),
251251
- builds all documentation locally (`make build_documentation`),
252-
- save local version information of software and repositories to single file `versions.txt` (`make local_versions_save`),
252+
- saves local version information of software and repositories to single file `versions.txt` (`make local_versions_save`),
253253
- builds all images locally (see [limitations](#known-limitations), `make local_build`),
254254
- saves the just built images into the file `o2r-reference-implementation-images.tar` (`make local_save_images`),
255-
- saves all nested code repositories with their histories, to `o2r-reference-implementation-modules.zip`
256-
- saves all nested documentation repositories with their histories, to `o2r-docs.zip`
255+
- saves all nested repositories (including their histories)
256+
- reference implementation software to `o2r-reference-implementation-modules.zip`
257+
- documentation to `o2r-docs.zip`
258+
- reproduction package files (everything except `README` files and `Makefile`) to `o2r-reference-implementation-files.zip`
257259
1. Create a new deposit or a new version of the existing deposit on Zenodo
258-
1. Upload the _small files_ to [Zenodo deposit](https://zenodo.org/api/deposit/depositions/2203844): `ZENODO_DEPOSIT_ID=2203844 ZENODO_ACCESS_TOKEN=xxxxxx make upload_files_to_zenodo` (the used Python scripts needs the module `humanfriendly`)
260+
1. Upload the _small files_ to the just created Zenodo deposit ([first version](https://zenodo.org/api/deposit/depositions/2203844), the used Python scripts needs the module `humanfriendly`; `ZENODO_DEPOSIT_ID=xxxxxx ZENODO_ACCESS_TOKEN=xxxxxx make upload_files_to_zenodo`)
259261
1. Manually upload the _big file_ to Zenodo deposit ([Zenodo API currently has a 100 MB file limit](http://developers.zenodo.org/#deposition-files))
260262
1. Fill out metadata form on Zenodo and publish using the "Publish" button
261263

0 commit comments

Comments
 (0)