Skip to content

Commit d934a03

Browse files
authored
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.
1 parent 39515d4 commit d934a03

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,13 +75,14 @@ https://www.npmjs.com/package/@chainsafe/eth2.0-api-wrapper
7575

7676
1. Create and push tag
7777

78-
- Make sure info.version in beacon-node-oapi.yaml file is updated before tagging.
78+
- 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.
7979
- CD will create github release and upload bundled spec file
8080

81-
2. Add release entrypoint in index.html
81+
2. Create a second PR, containing the updated `index.html`. Also change back the `info.version` in `beacon-node-api.yaml` back to `Dev`
8282

83-
In SwaggerUIBundle configuration (inside index.html file), add another entry in "urls" field (SwaggerUI will load first item as default).
84-
Entry should be in following format(replace `<tag>` with real tag name from step 1.):
85-
```javascript
86-
{url: "./releases/<tag>/beacon-node-oapi.json", name: "<tag>"},
83+
- The `index.html` file needs a new release entrypoint added to refer to the new release. Find the `urls` field,
84+
and add the new release as the first entry in the list.
85+
Entry should be in following format(replace `<tag>` with real tag name from step 1.):
8786
```
87+
{url: "./releases/<tag>/beacon-node-oapi.json", name: "<tag>"},
88+
```

beacon-node-oapi.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ info:
2121
2222
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.
2323
24-
version: "Dev - Ethereum Proof-of-Stake Consensus Specification v1.4.0-alpha.3"
24+
version: "v2.4.2 - Ethereum Proof-of-Stake Consensus Specification v1.4.0-beta.1"
2525
contact:
2626
name: Ethereum Github
2727
url: https://github.com/ethereum/beacon-apis/issues

0 commit comments

Comments
 (0)