Skip to content

Commit 608a1f1

Browse files
arnoweissjimmarino
authored andcommitted
chore: publish 2025-1-RC2
1 parent 05a0a91 commit 608a1f1

File tree

3 files changed

+54
-21
lines changed

3 files changed

+54
-21
lines changed

.github/scripts/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="refresh"
6-
content="0;url=https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-RC1"/>
7-
<link rel="canonical" href="https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-RC1"/>
6+
content="0;url=https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-RC2"/>
7+
<link rel="canonical" href="https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-RC2"/>
88
</head>
99
<body>
1010
<h4>
11-
This redirects to the latest Release Candidate <a href="https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-RC1">here</a>
11+
This redirects to the latest Release Candidate <a href="https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-RC2">here</a>
1212
</h4>
1313
</body>
1414
</html>

WEBSITE.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,36 @@ be easy.
2727

2828
1. Locally execute the commands from the [autopublish](.github/workflows/autopublish.yaml) workflow's "Copy files for correct web access" step. All resulting folders and files are duplicates, gitignored and don't break anything.
2929
2. Open the `index.html` file.
30-
3. You IDE should have a feature to display html documents (either in your browser of choice or inline). Use that and you should always see the updated webpage when saving.
30+
3. You IDE should have a feature to display html documents (either in your browser of choice or inline). Use that and you should always see the updated webpage when saving.
31+
32+
### Publishing versions
33+
34+
When wanting to pin and publish a snapshot in time via a separate url-path, follow the appropriate steps listed below.
35+
36+
#### Prep commits
37+
38+
When the content is finished, a release requires a first commit with
39+
40+
1. a tag with the exact version string (like `2025-1-RC1`) on the release commit
41+
2. to change the redirect in `.github/scripts/index.html` to point to latest release candidate
42+
3. set the `respecConfig.publishDate` in `index.html` to a string like `"2025-02-27"`,`
43+
4. set the `respecConfig.specStatus` in `index.html` to `base`
44+
45+
In case of versions with a new namespace, additionally:
46+
47+
5. adjust the textual description of the context URI in the base spec
48+
6. appended w3id referrals
49+
50+
and then (independently of major/minor) a second commit
51+
52+
1. setting the specStatus config option to `unofficial` and
53+
2. increase the spec version in the title of `index.html`
54+
3. remove the release date
55+
56+
#### Push and build
57+
58+
- Open a PR with both commits. Wait for it to be merged.
59+
- Push the tag to origin/main on Github.
60+
- Rerun the actions.
61+
62+
You should now see an additional endpoint at `https://eclipse-dataspace-dcp.github.io/decentralized-claims-protocol/my-version-tag/`.

index.html

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,15 @@
66
<script class="remove" src="https://cdn.jsdelivr.net/gh/w3c/[email protected]/dist/main.js"></script>
77
<script class='remove'>
88
var respecConfig = {
9-
specStatus: "unofficial",
10-
latestVersion: "https://docs.internationaldataspaces.org/ids-knowledgebase/dataspace-protocol",
11-
editors: [{
12-
name: "Sebastian Steinbuss",
13-
url: "https://github.com/ssteinbuss",
14-
company: "International Data Spaces Association",
15-
companyURL: "https://internationaldataspaces.org/",
16-
}],
9+
specStatus: "base",
10+
latestVersion: "https://docs.internationaldataspaces.org/ids-knowledgebase/dataspace-protocol",
11+
editors: [{
12+
name: "Sebastian Steinbuss",
13+
url: "https://github.com/ssteinbuss",
14+
company: "International Data Spaces Association",
15+
companyURL: "https://internationaldataspaces.org/",
16+
}],
17+
publishDate: "2025-06-19",
1718
authors: [
1819
{
1920
name: "Peter Koen",
@@ -48,17 +49,17 @@
4849
{
4950
name: "Arno Weiß",
5051
url: "https://github.com/arnoweiss",
51-
company: "SAP"
52+
company: "SAP SE"
5253
},
5354
],
54-
github: {
55-
branch: "main",
56-
repoURL: "eclipse-dataspace-protocol-base/DataspaceProtocol",
57-
},
58-
xref: "web-platform",
59-
lint: { "no-unused-dfns": false, "local-refs-exist": true },
60-
format: "markdown",
61-
maxTocLevel: 3,
55+
github: {
56+
branch: "main",
57+
repoURL: "eclipse-dataspace-protocol-base/DataspaceProtocol",
58+
},
59+
xref: "web-platform",
60+
lint: { "no-unused-dfns": false, "local-refs-exist": true },
61+
format: "markdown",
62+
maxTocLevel: 3,
6263
};
6364
</script>
6465
<title>Dataspace Protocol Release 2025-1-RC2</title>

0 commit comments

Comments
 (0)