Skip to content

Commit

Permalink
Updated info.version for release. (#343)
Browse files Browse the repository at this point in the history
Also tweaked the releasing section of the readme to better describe changing the info.version back after release is complete.
  • Loading branch information
rolfyone authored Aug 6, 2023
1 parent 39515d4 commit d934a03
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<tag>` with real tag name from step 1.):
```javascript
{url: "./releases/<tag>/beacon-node-oapi.json", name: "<tag>"},
- 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 `<tag>` with real tag name from step 1.):
```
{url: "./releases/<tag>/beacon-node-oapi.json", name: "<tag>"},
```
2 changes: 1 addition & 1 deletion beacon-node-oapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit d934a03

Please sign in to comment.