From d934a03187729635bef06ca7f3c067645c3eab15 Mon Sep 17 00:00:00 2001 From: Paul Harris Date: Mon, 7 Aug 2023 09:01:38 +1000 Subject: [PATCH] Updated info.version for release. (#343) Also tweaked the releasing section of the readme to better describe changing the info.version back after release is complete. --- README.md | 13 +++++++------ beacon-node-oapi.yaml | 2 +- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 396f5af4..a42edfe0 100644 --- a/README.md +++ b/README.md @@ -75,13 +75,14 @@ https://www.npmjs.com/package/@chainsafe/eth2.0-api-wrapper 1. Create and push tag - - Make sure info.version in beacon-node-oapi.yaml file is updated before tagging. + - Make sure `info.version` in `beacon-node-oapi.yaml` file is updated before tagging. This will need to be a PR, and will get the release process started. - CD will create github release and upload bundled spec file -2. Add release entrypoint in index.html +2. Create a second PR, containing the updated `index.html`. Also change back the `info.version` in `beacon-node-api.yaml` back to `Dev` -In SwaggerUIBundle configuration (inside index.html file), add another entry in "urls" field (SwaggerUI will load first item as default). -Entry should be in following format(replace `` with real tag name from step 1.): -```javascript - {url: "./releases//beacon-node-oapi.json", name: ""}, + - The `index.html` file needs a new release entrypoint added to refer to the new release. Find the `urls` field, + and add the new release as the first entry in the list. + Entry should be in following format(replace `` with real tag name from step 1.): ``` + {url: "./releases//beacon-node-oapi.json", name: ""}, +``` \ No newline at end of file diff --git a/beacon-node-oapi.yaml b/beacon-node-oapi.yaml index 01560874..c926bdee 100644 --- a/beacon-node-oapi.yaml +++ b/beacon-node-oapi.yaml @@ -21,7 +21,7 @@ info: Note that it is possible for a field to be added to an endpoint's data or metadata without an increase in the version number. - version: "Dev - Ethereum Proof-of-Stake Consensus Specification v1.4.0-alpha.3" + version: "v2.4.2 - Ethereum Proof-of-Stake Consensus Specification v1.4.0-beta.1" contact: name: Ethereum Github url: https://github.com/ethereum/beacon-apis/issues