Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated info.version for release. #343

Merged
merged 1 commit into from
Aug 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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