Skip to content

Commit bef2cc5

Browse files
author
MDM Playground Refresh
committed
Apply playground overlay (refresh from canonical)
1 parent 59a0c4e commit bef2cc5

3 files changed

Lines changed: 137 additions & 60 deletions

File tree

‎.github/workflows/publish_site.yml‎

Lines changed: 21 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,30 @@
1+
# Playground stub — replaces the real Antora build with a 60-second
2+
# no-op that always succeeds. The wizard's task-4 probe watches the
3+
# latest push-triggered workflow run on this repo's default branch;
4+
# the real Antora build needs node_modules + the eforms-docs-playground
5+
# source clone + the website build, none of which we want to maintain
6+
# here. This stub gives the wizard a realistic queued → in_progress →
7+
# completed (success) transition to observe without any of that.
8+
#
9+
# To replicate the real build on this repo, copy publish_site.yml back
10+
# from OP-TED/OP-TED.github.io and add the matching yarn.lock.
11+
112
name: Build and publish TED Developer Docs
213

314
on:
415
workflow_dispatch:
516
push:
6-
branches:
17+
branches:
718
- master
819

920
jobs:
10-
publish_site:
11-
name: "Build and publish site with Antora"
12-
runs-on: [ubuntu-latest]
13-
env:
14-
ACTIONS_ALLOW_UNSECURE_COMMANDS: 'true'
15-
NODE_OPTIONS: '--max-old-space-size=8192'
21+
simulate_publish:
22+
name: Simulate publish (playground stub)
23+
runs-on: ubuntu-latest
1624
steps:
17-
- name: Checkout
18-
uses: actions/checkout@v4
19-
20-
- name: Setup Node.js for use with actions
21-
uses: actions/setup-node@v4
22-
with:
23-
node-version: 18
24-
25-
- name: Install Corepack
26-
run: npm install --prefix .node corepack
27-
28-
- name: Install Yarn
29-
run: .node/node_modules/.bin/corepack enable --install-directory .node
30-
31-
- name: Install packages
32-
run: .node/yarn install
33-
34-
- name: Generate site
35-
run: yarn run build
36-
37-
- name: Deploy to GitHub Pages
38-
uses: JamesIves/github-pages-deploy-action@v4
39-
with:
40-
token: "${{ github.token}}"
41-
folder: build/site
42-
branch: 'gh-pages'
43-
commit-message: "[CI] Publish Documentation for ${{ github.sha }}"
25+
- name: Idle for ~60s so the wizard can observe the transition
26+
run: |
27+
echo "Playground stub for the docs-publish workflow."
28+
echo "Sleeping 60s to simulate a real build."
29+
sleep 60
30+
echo "Done — exit success."

‎README.md‎

Lines changed: 81 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,82 @@
1-
# TED Developer Documentation
1+
# docs-playground
22

3-
This is the main repository responsible for the aggregation of all TED Developer documentation into https://docs.ted.europa.eu.
3+
This repository is a copy of [`OP-TED/OP-TED.github.io`](https://github.com/OP-TED/OP-TED.github.io)
4+
(*canonical repository*) maintained by the Release Wizard of the eForms
5+
Metadata Manager application (MDM) for testing the SDK release process
6+
automation. It is not the production site and it is not consumed by any
7+
downstream system.
8+
9+
If you are looking for the real TED Developer Docs source, please use
10+
[`OP-TED/OP-TED.github.io`](https://github.com/OP-TED/OP-TED.github.io)
11+
instead.
12+
13+
## How this repository differs from the canonical repository
14+
15+
Three files are replaced by the wizard each time it refreshes this
16+
repository:
17+
18+
- **This README.** The canonical repository's README describes the real
19+
TED Developer Docs site and would mislead anyone landing here by
20+
accident. It is replaced by the text you are now reading so that
21+
visitors are warned immediately.
22+
- **`.github/workflows/publish_site.yml`.** The canonical workflow runs
23+
a full Antora build of the documentation site, which requires
24+
`node_modules`, a `yarn.lock`, and several minutes of checkout and
25+
rendering. None of that is useful in a wizard test, where what
26+
matters is only that a workflow run progresses from *queued* to
27+
*running* to *completed* so the wizard's polling code can observe
28+
the transition. The replacement workflow is a sixty-second no-op
29+
that always succeeds.
30+
- **`antora-playbook.yml`.** The canonical playbook reads documentation
31+
content from `OP-TED/eforms-docs`. In the playground it is rewired
32+
to [`OP-TED/eforms-docs-playground`](https://github.com/OP-TED/eforms-docs-playground)
33+
so that the test cycle stays self-contained: the branches and
34+
content the wizard pushes during testing live in the docs-playground
35+
mirror of the docs repository, and this playbook reads from there.
36+
37+
GitHub Pages is also not enabled on this repository, so even the stub
38+
workflow does not publish anything that would be visible on the public
39+
web.
40+
41+
## How this repository is refreshed
42+
43+
The MDM Release Wizard exposes a refresh button on the *Start a new
44+
release* card. The operator may press it at any time before starting
45+
a release test. The button opens a dialogue in which one or more
46+
playground repositories may be selected for refresh. When this
47+
repository is selected, the wizard force-pushes the canonical
48+
repository's current state onto it, deletes any branches and tags
49+
that do not exist on the canonical, and then re-applies the three
50+
overlay files listed above (this README included).
51+
52+
The refresh button is shown only when the MDM instance is configured
53+
to use playground repositories — that is, in development and other
54+
non-production deployments. In production, where MDM is configured
55+
against the canonical repositories, the button is not shown and the
56+
underlying endpoints are disabled.
57+
58+
Because every refresh erases local state on this repository, please
59+
do not open pull requests against it, do not push commits to it, and
60+
do not rely on its branches, tags, or GitHub Releases as a source of
61+
truth. The authoritative artefacts live on the canonical repository
62+
linked above.
63+
64+
## Other playground repositories used for testing the SDK release process
65+
66+
The MDM Release Wizard maintains a small family of playground
67+
repositories under the same `OP-TED` organisation, each mirroring the
68+
corresponding canonical repository for testing:
69+
70+
- [`OP-TED/eforms-sdk-playground`](https://github.com/OP-TED/eforms-sdk-playground)
71+
— mirror of [`OP-TED/eforms-sdk`](https://github.com/OP-TED/eforms-sdk),
72+
used to test the SDK release flow itself.
73+
- [`OP-TED/eforms-docs-playground`](https://github.com/OP-TED/eforms-docs-playground)
74+
— mirror of [`OP-TED/eforms-docs`](https://github.com/OP-TED/eforms-docs),
75+
used as the target of the wizard's documentation export step.
76+
- [`OP-TED/eforms-sdk-analyzer-playground`](https://github.com/OP-TED/eforms-sdk-analyzer-playground)
77+
— mirror of [`OP-TED/eforms-sdk-analyzer`](https://github.com/OP-TED/eforms-sdk-analyzer),
78+
used to test the analyser release flow that runs in parallel with
79+
the SDK release.
80+
81+
Each of these repositories carries a similar README and is refreshed
82+
by the wizard in the same way.

‎antora-playbook.yml‎

Lines changed: 35 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ site:
22
title: TED Developer Docs
33
url: https://docs.ted.europa.eu
44
start_page: home::index.adoc
5+
robots: disallow
56

67
antora:
78
extensions:
@@ -23,7 +24,7 @@ asciidoc:
2324
#
2425
# We want to know the latest version of each component so we can create a redirect for the latest version.
2526
# Such a redirect would be useful for users that want to bookmark a link to the latest documentation for a component.
26-
# For example, we would be able to provide a link of the form: https://docs.ted.europa.eu/eforms/latest.
27+
# For example, we would be able to provide a link of the form: https://docs.ted.europa.eu/eforms/latest.
2728
# It is also nice to be able to indicate a component's version in the main navigation panel (modules/ROOT/nav.adoc).
2829
#
2930
# However, we do not currently have any other way to determine the latest version of a component outside a page in the component itself.
@@ -32,7 +33,7 @@ asciidoc:
3233
#
3334
eforms_latest_version: '1.14'
3435
epo_latest_version: '5.2.0'
35-
espd_latest_version: '4.1.0'
36+
espd_latest_version: '5.0.0'
3637
api_latest_version: '3.0'
3738

3839
extensions:
@@ -48,36 +49,46 @@ content:
4849
branches: HEAD
4950

5051
### eForms SDK
51-
- url: https://github.com/OP-TED/eforms-docs.git
52+
- url: https://github.com/OP-TED/eforms-docs-playground.git
5253
start_path: /
53-
branches: 1.14.x, 1.14.x-generated, 1.13.x, 1.13.x-generated, 1.12.x, 1.12.x-generated, main # The "main" branch contains the eForms FAQ and RoadMap
54+
branches: bugfix/1.12.x, 1.11.x, 1.11.x-generated, 1.10.x, 1.10.x-generated, 1.9.x, 1.9.x-generated, 1.8.x, 1.8.x-generated, 1.7.x, 1.7.x-generated, 1.6.x, 1.6.x-generated, 1.15.x, 1.15.x-generated, main # The "main" branch contains the eForms FAQ and RoadMap
55+
56+
### Playground note: every non-eForms-SDK source below is commented out
57+
### because this playground exists only to exercise the release wizard's
58+
### SDK-export flow. Skipping these sources cuts each Antora build from
59+
### several minutes (clone + render of every TED component) to seconds.
60+
### Restore by un-commenting if you ever need to mirror the full prod
61+
### site layout here.
62+
63+
### ePO Documentation
64+
# - url: https://github.com/OP-TED/epo-docs.git
65+
# start_path: /
66+
#
67+
# branches: main-wf, v*, pre-v*, wg-meetings, workflow-imp
5468

55-
### ePO Documentation
56-
- url: https://github.com/OP-TED/epo-docs.git
57-
start_path: /
58-
branches: main, v*, wg-meetings
5969

6070
### ESPD
61-
- url: https://github.com/OP-TED/espd-docs.git
62-
start_path: /
63-
branches: main, v1.0.x, v2.0.x, v2.1.x, v3.0.x, v3.1.x, v3.2.x, v3.3.x, v4.0.x, v4.1.x, wgm-reports
64-
#tags:
65-
#- 2.1.0
71+
# - url: https://github.com/OP-TED/espd-docs.git
72+
# start_path: /
73+
#
74+
# branches: main, v1.0.x, v2.0.x, v2.1.x, v3.0.x, v3.1.x, v3.2.x, v3.3.x, v4.0.x, v4.1.x, v5.0.x, v5.1.x ,wgm-reports
75+
# v4.0.x, v4-A1-feedback
6676

67-
### TED API
68-
- url: https://github.com/OP-TED/tedapi-docs.git
69-
start_path: /
70-
branches: v2.0, v3.0 # The "main" branch contains unversioned content.
77+
78+
### TED API
79+
# - url: https://github.com/OP-TED/tedapi-docs.git
80+
# start_path: /
81+
# branches: v2.0, v3.0NoticeLifecycle # The "main" branch contains unversioned content.
7182

7283
### TED Semantic Web Service
73-
- url: https://github.com/OP-TED/ted-rdf-docs
74-
start_path: docs/antora
75-
branches: main
76-
84+
# - url: https://github.com/OP-TED/ted-rdf-docs
85+
# start_path: docs/antora
86+
# branches: develop
87+
7788
### model2owl
78-
- url: https://github.com/OP-TED/ted-model2owl-docs
79-
start_path: /
80-
branches: main
89+
# - url: https://github.com/OP-TED/ted-model2owl-docs
90+
# start_path: /
91+
# branches: main
8192

8293
urls:
8394
redirect_facility: static

0 commit comments

Comments
 (0)