Fix how seeding process deals with release artefacts.

There are several problems with the way the seeding process (1) copies
the release artefacts from the src/ontology directory to the top-level
release directory and (2) optionally commits those files.

For (1), the problem is that the seeding script manually copies the
files itself, and do so by assuming too many things about those files.
Notably, it assumes they all go straight to the top-level directory,
whereas some should actually go a subdirectory (for example, report
files, when they are released, go into $(RELEASEDIR)/reports, not into
$(RELEASEDIR) directly; so do subset files).

The problem with (2) is a consequence of (1): if not all release files
have been correctly copied to their correct expected location in the
top-level directory, then the seeding script will try to `git add` files
that may not actually exist.

We fix (1) by adding a new helper target, `copy_release_files`, to take
care of copying all release files to the release directory. It is called
internally by the `prepare_release` target, and also by the seeding
script. This ensures that the same logic to copy release files will
always be used.

Wr fix (2) by updating the `show_release_assets` target (whose sole
real purpose is to be used by the seeding script) to list the _actual_
release files: that is, the files that are in the release directory,
rather than the files under src/.

Author: gouttegd

odk/odk.py

@@ -1464,11 +1464,11 @@ def seed(config, clean, outdir, templatedir, dependencies, title, user, source,
                format(dir=outdir,
                       branch=project.git_main_branch,
                       files=" ".join([t.replace(outdir, ".", 1) for t in tgts])))
-        runcmd("cd {dir}/src/ontology && make all_assets && cp $(make show_release_assets) ../../"
+        runcmd("cd {dir}/src/ontology && make all_assets copy_release_files"
                .format(dir=outdir))
         if commit_artefacts:
             runcmd("cd {dir}/src/ontology "
-                    "&& for asset in $(make show_release_assets) ; do git add -f ../../$asset ; done"
+                    "&& for asset in $(make show_release_assets) ; do git add -f $asset ; done"
                    .format(dir=outdir))
         runcmd("cd {dir} && if [ -n \"$(git status -s)\" ]; then git commit -a -m 'initial build' ; fi"
                .format(dir=outdir))

template/src/ontology/Makefile.jinja2

@@ -394,6 +394,15 @@ ASSETS = \
   $(SUBSET_FILES) \
   $(MAPPING_FILES)
 
+{# This does not include mappings (which can optionally be released),
+   because those are stored in src/mappings, and the fact that this is
+   one directory _above_ the directory where this Makefile is would
+   cause problems down the road (notably, it would prevent the use of a
+   single rsync commmand to copy all release assets except mappings to
+   the release directory). Basically, this is "all release assets that
+   are in this src/ontology directory".
+   This also does not include pattern-derived files, and it is unclear
+   whether this is by design or not, see #1243. -#}
 RELEASE_ASSETS = \
   $(MAIN_FILES) {% if project.import_group is defined %}{% if project.import_group.release_imports %}$(IMPORT_FILES) {% endif %}{% endif %}\
   $(SUBSET_FILES){% if project.robot_report.release_reports %} \
@@ -407,10 +416,6 @@ show_assets:
 	echo $(ASSETS)
 	du -sh $(ASSETS)
 
-.PHONY: show_release_assets
-show_release_assets:
-	@echo $(RELEASE_ASSETS)
-
 check_rdfxml_%: %
 	@check-rdfxml {% if project.extra_rdfxml_checks %}--jena --rdflib{% endif %} $<
 
@@ -426,22 +431,41 @@ KEEPRELATIONS=keeprelations.txt
 {% endif -%}
 
 CLEANFILES=$(MAIN_FILES) $(SRCMERGED) $(EDIT_PREPROCESSED)
+
 # This should be executed by the release manager whenever time comes to make a release.
 # It will ensure that all assets/files are fresh, and will copy to release folder
-
 .PHONY: prepare_release
-prepare_release: all_odk
-	rsync -R $(RELEASE_ASSETS) $(RELEASEDIR) &&\{% if project.sssom_mappingset_group is defined %}{% if project.sssom_mappingset_group.released_products is defined %}
-	mkdir -p $(RELEASEDIR)/mappings && cp -rf $(RELEASED_MAPPING_FILES) $(RELEASEDIR)/mappings &&\{% endif %}{% endif %}{% if project.use_dosdps %}
-	mkdir -p $(RELEASEDIR)/patterns && cp -rf $(PATTERN_RELEASE_FILES) $(RELEASEDIR)/patterns &&\{% endif %}
-	rm -f $(CLEANFILES) &&\
-	echo "Release files are now in $(RELEASEDIR) - now you should commit, push and make a release \
+prepare_release: all_odk copy_release_files
+	rm -f $(CLEANFILES)
+	@echo "Release files are now in $(RELEASEDIR) - now you should commit, push and make a release \
         on your git hosting site such as GitHub or GitLab"
 
 .PHONY: prepare_release_fast
 prepare_release_fast:
 	$(MAKE) prepare_release IMP=false PAT=false MIR=false COMP=false
 
+# This rule does the bulk of the work for prepare_release, copying all
+# files to the release directory. It is mostly intended for internal
+# use, by the prepare_release rule itself or by other ODK scripts.
+.PHONY: copy_release_files
+copy_release_files:
+	rsync -R $(RELEASE_ASSETS) $(RELEASEDIR){% if project.sssom_mappingset_group is defined %}{% if project.sssom_mappingset_group.released_products is defined %}
+	mkdir -p $(RELEASEDIR)/mappings
+	cp -rf $(RELEASED_MAPPING_FILES) $(RELEASEDIR)/mappings{% endif %}{% endif %}{% if project.use_dosdps %}
+	mkdir -p $(RELEASEDIR)/patterns
+	cp -rf $(PATTERN_RELEASE_FILES) $(RELEASEDIR)/patterns{% endif %}
+
+# All released assets, in their final location within the release
+{# ODK devs: keep that in sync with the copy_release_files rule above
+   -- that is, this should list all files copied by that rule (except
+   the pattern-derived files, whose status is unclear; see #1243). -#}
+RELEASE_ASSETS_AFTER_RELEASE=$(foreach n,$(RELEASE_ASSETS), $(RELEASEDIR)/$(n)){% if project.sssom_mappingset_group is defined %}{% if project.sssom_mappingset_group.released_products is defined %} \
+			     $(foreach n,$(RELEASED_MAPPINGS), $(RELEASEDIR)/mappings/$(n).sssom.tsv){% endif %}{% endif %}
+
+.PHONY: show_release_assets
+show_release_assets:
+	@echo $(RELEASE_ASSETS_AFTER_RELEASE)
+
 CURRENT_RELEASE=$(ONTBASE).owl
 
 $(TMPDIR)/current-release.owl:
@@ -1493,7 +1517,6 @@ public_release:
 	$(GITHUB_RELEASE_PYTHON) --release $(TAGNAME) $(RELEASEFILES)
 {% else  %}
 
-RELEASE_ASSETS_AFTER_RELEASE=$(foreach n,$(RELEASE_ASSETS), $(RELEASEDIR)/$(n)) $(foreach n,$(RELEASED_MAPPINGS), $(RELEASEDIR)/mappings/$(n).sssom.tsv)
 GHVERSION=v$(VERSION)
 
 .PHONY: public_release