Change sim swap file name #139
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Change links to accommodate file name change (sim-swap)
update links to accommodate file name change
Change links to accommodate file name change
README.md
Outdated
| @@ -21,13 +21,13 @@ Repository to describe, develop, document and test the SimSwap API family | |||
| ## Status and released versions | |||
|
|
|||
| * Note: Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**. | |||
| * The latest pre-release is [r1.1](https://github.com/camaraproject/SimSwap/releases/tag/r1.1). It contains: | |||
| * The latest pre-release is [r1.2](https://github.com/camaraproject/SimSwap/releases/tag/r1.2). It contains: | |||
There was a problem hiding this comment.
shouldn't this be updated in the r1.2 release PR?
There was a problem hiding this comment.
Yes probably - I'm still a bit confused about the release management. We can discuss this during Thursday call?
There was a problem hiding this comment.
I agree with @fernandopradocabrillo here ... if you merge this you would immediately afterwards need to create the release tag. Otherwise the link would go to nirvana until the release is created.
hdamker
reviewed
Aug 20, 2024
CHANGELOG.md
Outdated
Comment on lines
34
to
36
| - OpenAPI [YAML spec file](https://github.com/camaraproject/SimSwap/blob/r1.1/code/API_definitions/sim_swap.yaml) | ||
| - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.1/code/API_definitions/sim_swap.yaml&nocors) | ||
| - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.1/code/API_definitions/sim_swap.yaml) | ||
| - OpenAPI [YAML spec file](https://github.com/camaraproject/SimSwap/blob/r1.1/code/API_definitions/sim-swap.yaml) | ||
| - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.1/code/API_definitions/sim-swap.yaml&nocors) | ||
| - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.1/code/API_definitions/sim-swap.yaml) |
There was a problem hiding this comment.
You can't change the past history ... within r1.1 and therefore v1.0.0-rc.1 it will be still sim_swap.yaml.
Only for the next release entry (for the upcoming r1.2) you have to take remember to make the links correct.
hdamker
reviewed
Aug 20, 2024
README.md
Outdated
Comment on lines
28
to
30
| * OpenAPI [YAML](https://github.com/camaraproject/SimSwap/blob/r1.1/code/API_definitions/sim_swap.yaml) | ||
| * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.1/code/API_definitions/sim_swap.yaml&nocors) | ||
| * [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.1/code/API_definitions/sim_swap.yaml) | ||
| * OpenAPI [YAML](https://github.com/camaraproject/SimSwap/blob/r1.1/code/API_definitions/sim-swap.yaml) | ||
| * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.1/code/API_definitions/sim-swap.yaml&nocors) | ||
| * [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.1/code/API_definitions/sim-swap.yaml) |
There was a problem hiding this comment.
Same here ... you can't change the past ... with r1.1 it will stay sim_swap.yaml. In the release PR for r1.2 you will update the complete links.
hdamker
reviewed
Aug 20, 2024
| @@ -4,11 +4,11 @@ Checklist for sim-swap 1.0.0-rc.1 in r1.1 | |||
|
|
|||
| | Nr | API release assets | alpha | release-candidate | initial<br>public | stable<br> public | Status | Comments | | |||
| |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| | |||
| | 1 | API definition | M | M | M | M | Y | [link](code/API_definitions/sim_swap.yaml) | | |||
| | 1 | API definition | M | M | M | M | Y | [link](code/API_definitions/sim-swap.yaml) | | |||
There was a problem hiding this comment.
You would need also to change line 3 here ...
Revert change on readme.md
Revert changelog.md
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
Add one of the following kinds:
What this PR does / why we need it:
Change the yaml name from
sim_swaptosim-swapWhich issue(s) this PR fixes:
Fixes #138
Special notes for reviewers:
Changelog input
Additional documentation
Additionally to the file name change, the CHANGELOG.md, README.me & API readiness checklist have been updated for links.
Shift to rc1.2 in README.md file.