Automatic Confluence Update

.gitlab-ci.yml

@@ -0,0 +1,29 @@
+stages:
+  - generate
+  - publish
+
+generate-job:
+    stage: generate
+    tags:
+        - autoscale
+    variables:
+        REPO_METADATA_FILE: docs/includes/repo-metadata.md
+    script: >
+        echo "Created from: [$CI_PROJECT_NAMESPACE / $CI_PROJECT_TITLE]($CI_PROJECT_URL) Version: $(git describe --always)" > "$REPO_METADATA_FILE"
+    artifacts:
+        paths:
+            - "$REPO_METADATA_FILE"
+
+mark-job:
+    stage: publish
+    only:
+        - devel
+        - master
+    image: wsinpg/mark:latest
+    tags:
+        - autoscale
+    script: >
+        for f in $(find . -name includes -type d -prune -o -name README.md -prune -o -name '*.md' -print0 | xargs -0); do
+          echo 'username = ""' && echo "password = '$CONFLUENCE_PERSONAL_ACCESS_TOKEN'" | 
+            mark -c /dev/stdin -b https://ssg-confluence.internal.sanger.ac.uk -f "$f" --trace
+        done

Changes

@@ -1,5 +1,8 @@
 LIST OF CHANGES
 
+ - docs
+   - Automatic confluence update for 'docs/instruments.md'
+
 release 101.2.0 (2024-05-24)
  - remove dependency on HTML::Tidy
  - update NovaSeqX icon

docs/api_usage.md

@@ -1,3 +1,20 @@
+<!-- Space: NPG -->
+<!-- Parent: Tracking -->
+<!-- Title: API usage -->
+
+<!-- Macro: :box:([^:]+):([^:]*):(.+):
+     Template: ac:box
+     Icon: true
+     Name: ${1}
+     Title: ${2}
+     Body: ${3} -->
+
+:box:info:Note:This page is automatically generated; any edits will be overwritten:
+
+###### Repository information
+
+<!-- Include: docs/includes/repo-metadata.md -->
+
 # NPG Tracking API usage
 
 There are two APIs in active use for NPG Tracking: once Clearpress based, the other DBIx::Class based.

docs/includes/repo-metadata.md

@@ -0,0 +1 @@
+Created from: -  Version: -

docs/instruments.md

@@ -1,3 +1,20 @@
+<!-- Space: NPG -->
+<!-- Parent: Tracking -->
+<!-- Title: All About Illumina Instruments -->
+
+<!-- Macro: :box:([^:]+):([^:]*):(.+):
+     Template: ac:box
+     Icon: true
+     Name: ${1}
+     Title: ${2}
+     Body: ${3} -->
+
+:box:info:Note:This page is automatically generated; any edits will be overwritten:
+
+###### Repository information
+
+<!-- Include: docs/includes/repo-metadata.md -->
+
 # All About Illumina Instruments
 
 ## Create Instrument

docs/run_states.md

@@ -1,3 +1,20 @@
+<!-- Space: NPG -->
+<!-- Parent: Tracking -->
+<!-- Title: Run States -->
+
+<!-- Macro: :box:([^:]+):([^:]*):(.+):
+     Template: ac:box
+     Icon: true
+     Name: ${1}
+     Title: ${2}
+     Body: ${3} -->
+
+:box:info:Note:This page is automatically generated; any edits will be overwritten:
+
+###### Repository information
+
+<!-- Include: docs/includes/repo-metadata.md -->
+
 # Run States
 
 The Tracking interface shows a sequence of states for Illumina runs. They have the following meanings in approximate order of execution:

docs/user_management.md

@@ -1,3 +1,20 @@
+<!-- Space: NPG -->
+<!-- Parent: Tracking -->
+<!-- Title: User Management -->
+
+<!-- Macro: :box:([^:]+):([^:]*):(.+):
+     Template: ac:box
+     Icon: true
+     Name: ${1}
+     Title: ${2}
+     Body: ${3} -->
+
+:box:info:Note:This page is automatically generated; any edits will be overwritten:
+
+###### Repository information
+
+<!-- Include: docs/includes/repo-metadata.md -->
+
 # How to give users the permissions to set up a run 
 Users that use the NPG pipeline could ask, through a ticket, to be 
 granted some permissions to set up runs.