Skip to content
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,17 @@ jobs:
steps:

- name: Checkout the repository
uses: actions/checkout@v1
uses: actions/checkout@v4
with:
submodules: true

- name: Setup dependencies
run: |
sudo apt update
sudo apt install texlive-latex-base texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended xsltproc latexmk cm-super texlive-extra-utils
sudo apt install texlive-latex-base texlive-latex-recommended \
texlive-latex-extra texlive-fonts-recommended \
librsvg2-bin latexmk \
pdftk xsltproc latexmk cm-super

- name: Build the document
run: make
Expand All @@ -39,7 +42,7 @@ jobs:
test -f ${{ env.doc_name }}.bbl

- name: Keep the PDF artefact
uses: actions/upload-artifact@v1
uses: actions/upload-artifact@v4
with:
name: PDF Preview
path: ${{ env.doc_name }}.pdf
58 changes: 33 additions & 25 deletions .github/workflows/preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@
name: Update PDF Preview

env:
doc_name: data-origin
doc_name : data-origin
branch_name: ${{ github.head_ref || github.ref_name }}
tag_preview: auto-pdf-preview

on:
push:
Expand All @@ -22,15 +24,17 @@ jobs:
steps:

- name: Checkout the repository
uses: actions/checkout@v1
uses: actions/checkout@v4
with:
submodules: true

- name: Setup dependencies
run: |
sudo apt update
sudo apt install texlive-latex-base texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended xsltproc latexmk cm-super texlive-extra-utils
sudo snap install pdftk
sudo apt install texlive-latex-base texlive-latex-recommended \
texlive-latex-extra texlive-fonts-recommended \
librsvg2-bin latexmk \
pdftk xsltproc latexmk cm-super

- name: Build the document
run: make ${{ env.doc_name }}-draft.pdf
Expand All @@ -40,27 +44,31 @@ jobs:
test -f ${{ env.doc_name }}-draft.pdf
test -f ${{ env.doc_name }}.bbl

- name: Move the auto-pdf-preview tag
uses: weareyipyip/walking-tag-action@v2
with:
tag-name: auto-pdf-preview
tag-message: |
Last commit taken into account for the automatically updated PDF preview of this IVOA document.
- name: Remove the former PDF preview (if any)
run: |
existingTag=$( gh release list --exclude-drafts --json 'isPrerelease,tagName' \
--jq '.[] | select(.isPrerelease == true and .tagName == "${{ env.tag_preview }}") | .tagName' \
| xargs -n 1 echo )
if [ -n "$existingTag" ];
then
gh release delete --cleanup-tag "$existingTag"
fi
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Update the PDF preview
uses: Xotl/cool-github-releases@v1
with:
mode: update
isPrerelease: true
tag_name: auto-pdf-preview
release_name: "Auto PDF Preview"
body_mrkdwn: |
This release aims to provide a PDF preview of the last commit applied on this repository.
- name: Upload the new PDF preview
run: |
RELEASE_NOTES="This release aims to provide a PDF preview of the last commit applied on this repository.
It will be updated automatically after each merge of a PullRequest.
**DO NOT PUBLISH THIS PRE-RELEASE!**"
_Corresponding commit: ${{ github.sha }}_
assets: ${{ env.doc_name }}-draft.pdf
replace_assets: true
github_token: ${{ secrets.GITHUB_TOKEN }}
**DO NOT PUBLISH THIS PRE-RELEASE!**
_Corresponding commit: ${{ github.sha }}_"

gh release create ${{ env.tag_preview }} \
${{ env.doc_name }}-draft.pdf \
--prerelease \
--target "${{ env.branch_name }}" \
--title 'Auto PDF Preview' \
--notes "$RELEASE_NOTES"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

36 changes: 3 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,6 @@ The following metadata can be repeated and could follow a controlled vocabulary.

- Author: name or ORCID
- Organization: name or URL
- Editor: name or URL
- Journal: name or URL
- Datacenter that provides the result: name or URL
- Contact: email
Expand Down Expand Up @@ -115,7 +114,6 @@ For queries on evolving dataset, the version or the date must complete the infor
|version | Dataset version (or release date) | |
|service_protocol| Protcol access with version | |
|request| Request url  | |
|request_post| (POST Request) POST arguments **new**  | |
|request_date| Query execution date | |
|contact| email or URL contact | |
|landing_page| Dataset landing page | |
Expand All @@ -133,12 +131,11 @@ Dataset-origin completes the "Query information" -
|Publication-id| Dataset identifier that can be used for citation | yes |
|Curation-level| Controled vocabulary | |
|Resource-version| Dataset version od last release | |
|Rights| Licence URI | |
|Rights-type| Licence type (eg: CC-by, CC-0, private, public) | |
|Copyrights| Copyright text | |
|Rights_URI| Licence URI | |
|Rights| Licence type (eg: CC-by, CC-0, private, public) or copyrights| |
|Creator| Dataset Author(s) or group | |
|Publication-ref| Identifier of the original resource that can be an article or the origin Data Center|
|Editor| editor name| |
|Journal or Editor| journal or editor name| |
|Relation_type | controled vocabulary (VOResource: relationshipType ? ) to specify relation to related resource **new**|
|related_resource | Original resource **new**|
|Publication-date| Date of the original publication | |
Expand All @@ -152,33 +149,6 @@ eg: bibcode:...,
Serialisation example: &lt;info&gt; tag makes the jobs. see <a href='tests/J_AJ_161_36_table8.xml'>SCS example</a>


- Complex output involving **several tables** (eg: TAP query, ObsCore result)

Dataset-origin depends on each table used for the output. Datamodels like Last-step -Provenance or DatasetDM allows to gather the metadata.

DatasetDM Example:

|meta-data| Description| Mandatory |
|--- |:-: |:-: |
|dataset:productType|||
|dataset:productSubType| controled vocabulary||
|dataset:DataID.datasetDID| dataset ivoid|yes|
|dataset:DataID.title| dataset title||
|dataset:DataID.creationType| type of resource ||
|dataset:DataID.date| Publication date of original dataset/article||
|dataset:Party.name| (first)Author | |
|dataset:Curation.publisherDID| data-center identifier (ivoid)|yes|
|dataset:Curation.rights| rights text| |
|dataset:Curation.releaseDate| Data-center publication date|yes|
|party.Organisation.email|Data-center contact||
|dataset:Curation.doi| Dataset DOI| |
|dataset:Curation.bibcode| Dataset bibcode||

Serialisation example: DatasetDM serialisation. see <a href='tests/tap.xml'>TAP example</a>

(see also: <a href='https://wiki.ivoa.net/twiki/pub/IVOA/InterOpOct2022DM/IVOA-DMTAP-VizieR.pdf'>datasetDM in TAP (ivoa-talk)</a>



# About
This document describes simple means to declare basic provenance
Expand Down
Loading