[C++][Markdown][Security] Exclude Badges in Generated README.md#23163
Open
Chrimle wants to merge 2 commits intoOpenAPITools:masterfrom
Open
[C++][Markdown][Security] Exclude Badges in Generated README.md#23163Chrimle wants to merge 2 commits intoOpenAPITools:masterfrom
README.md#23163Chrimle wants to merge 2 commits intoOpenAPITools:masterfrom
Conversation
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Contributor
Author
|
Ready for review 🙌 @wing328 |
README.mdREADME.md
README.mdREADME.md
Member
|
cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @martin-mfg (2023/08) |
This file contains hidden or 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
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.
Embedding "Badges" in Markdown could pose varying Security risks. Although the currently generated Badges appear innocent, they will invoke HTTP GET requests to the embedded URLs. One of the badges, links to the MIT license, which is little-to-no-use, as a regular link would suffice. The other badge, links to a 404 page. Hence, keeping these badges around is just a security liability.
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)Summary by cubic
Remove Travis CI and MIT license badges from the cpp-qt-qhttpengine-server README template and update generated samples to match. This prevents external HTTP requests from badges and removes a broken link in generated README files.
Written for commit bc23a1c. Summary will update on new commits.