feat: check markdown links on the CI #958
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
vscaiceanu-1a
force-pushed
the
feature/md-link-check
branch
from
9b08d37 to
41e4d7b
Compare
vscaiceanu-1a
force-pushed
the
feature/md-link-check
branch
3 times, most recently
from
6bd3a1d to
8496084
Compare
kpanot
reviewed
Oct 27, 2023
vscaiceanu-1a
force-pushed
the
feature/md-link-check
branch
2 times, most recently
from
231d1ae to
61374bd
Compare
vscaiceanu-1a
force-pushed
the
feature/md-link-check
branch
from
61374bd to
5f2a0fa
Compare
vscaiceanu-1a
force-pushed
the
feature/md-link-check
branch
2 times, most recently
from
6dadf7c to
e55a0b9
Compare
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 0e643a8. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 2 targetsSent with 💌 from NxCloud. |
vscaiceanu-1a
force-pushed
the
feature/md-link-check
branch
from
e55a0b9 to
b42a1cd
Compare
vscaiceanu-1a
changed the title
vscaiceanu-1a
force-pushed
the
feature/md-link-check
branch
from
b42a1cd to
aa3017f
Compare
vscaiceanu-1a
force-pushed
the
feature/md-link-check
branch
2 times, most recently
from
4ac2896 to
e972790
Compare
kpanot
reviewed
Jan 4, 2024
...s/schematics/java/client-core/swagger-codegen-java-client/config/swagger-codegen-config.json
Show resolved
Hide resolved
vscaiceanu-1a
force-pushed
the
feature/md-link-check
branch
from
e972790 to
6858dfa
Compare
sdo-1A
reviewed
Jan 5, 2024
| @@ -42,15 +42,15 @@ In your generator project, a single jar file will be produced in `target`. You | |||
| java -cp "/path/to/swagger-codegen-cli.jar;/path/to/mdk/target/folder/mdk-swagger-codegen-0.0.0.jar;" \ | |||
| io.swagger.codegen.SwaggerCodegen generate -l javaMdk \ | |||
| -i "/path/to/your/swagger/spec/file/Airline_Public.yaml" \ | |||
| -c "/pth/to/thi/project/config/swagger-codegen-config.json" \ | |||
| -c "/pth/to/the/project/config/swagger-codegen-config.json" \ | |||
There was a problem hiding this comment.
Suggested change
| -c "/pth/to/the/project/config/swagger-codegen-config.json" \ | |
| -c "/path/to/the/project/config/swagger-codegen-config.json" \ |
|
|
||
| ``` | ||
| { | ||
| "groupId" : "com.airline.dapi", // Generated Maven project Goupt ID | ||
| "groupId" : "com.airline.dapi", // Generated Maven project Goupt ID |
There was a problem hiding this comment.
do we want all of these references to dapi ?
There was a problem hiding this comment.
this file is already present twice in the repo. I created an issue to remove all references to DAPI/DES/Digital #1190
| @@ -101,6 +101,3 @@ A code generator is provided to generate an extension of the **Amadeus Digital E | |||
| ```bash | |||
| yarn yo @ama-sdk/sdk:api-extension | |||
There was a problem hiding this comment.
maybe remove reference to Amadeus Digital in the line above (line 99) ?
A code generator is provided to generate an API specification extension.
| @@ -106,6 +106,3 @@ A code generator is provided to generate an extension of the **Amadeus Digital E | |||
| ```bash | |||
| yarn yo @ama-sdk/sdk:api-extension | |||
There was a problem hiding this comment.
same here, remove reference to Amadeus Digital (line 104) ?
A code generator is provided to generate an API specification extension.
vscaiceanu-1a
force-pushed
the
feature/md-link-check
branch
from
6858dfa to
bd66642
Compare
sdo-1A
previously approved these changes
Jan 5, 2024
kpanot
reviewed
Jan 5, 2024
There was a problem hiding this comment.
can you move this file to .github with other task configuration file?
vscaiceanu-1a
force-pushed
the
feature/md-link-check
branch
from
bd66642 to
0e643a8
Compare
mrednic-1A
approved these changes
Jan 8, 2024
sdo-1A
approved these changes
Jan 8, 2024
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.
Proposed change
While exploring the documentation, I've noticed some broken link.
I found markdown-link-check which does a good job for both relative and external links.
Ideally we could have 2 separate runs: one on modified files on PRs and a second one triggered every month on all
mdfiles to check for broken external links.