Skip to content

Conversation

@2bndy5
Copy link
Contributor

@2bndy5 2bndy5 commented Aug 19, 2022

solves #1

@codecov-commenter
Copy link

codecov-commenter commented Aug 19, 2022

Codecov Report

❗ No coverage uploaded for pull request base (main@eb81b8f). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main       #2   +/-   ##
=======================================
  Coverage        ?   80.75%           
=======================================
  Files           ?        6           
  Lines           ?      639           
  Branches        ?        0           
=======================================
  Hits            ?      516           
  Misses          ?      123           
  Partials        ?        0           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

ensure demo src uses LF on git checkout
@shenxianpeng

This comment was marked as outdated.

@2bndy5
Copy link
Contributor Author

2bndy5 commented Aug 22, 2022

Ok I replaced most of the references to the old cpp-linter-action origin. I just want to point out that there are still a few that shouldn't be changed (or don't need to be changed):
image

  1. This is a hyperlink in the README to the cpp-linter-action which should contain how to use the pkg in a YAML file. I think the cpp-linter-action/README doesn't need to change after switching to composite action. But the README here should really focus on the executable script's CLI args.
    • Sphinx can be used to get the cpp-linter -h output and create a document from that, so the README here might just forward to the docs in the future. PyPi doesn't use Sphinx to parse the README, so it would throw an error if we generate this doc about CLI args in the README (must be done on a separate page).
  2. This test is using a specific commit from the test-cpp-linter-action repo. So, this doesn't need to change because the git history won't change there. After we get the migration complete (using the composite action approach), we can change the test here, but it isn't mandatory.

@shenxianpeng
Copy link
Contributor

The blurry logo in this PR should also be updated

@2bndy5
Copy link
Contributor Author

2bndy5 commented Aug 23, 2022

I've already updated the logo locally for this repo. But I'm working on updating the cpp-linter -h output, so we can use it to generate a cross-referencable doc.

Here's a teaser

image

@2bndy5 2bndy5 marked this pull request as ready for review August 23, 2022 10:39
@2bndy5
Copy link
Contributor Author

2bndy5 commented Aug 23, 2022

I created a gh-pages branch and uploaded the last local build of the docs. They are now live at https://cpp-linter.github.io/cpp-linter

The CLI args are now automatically documented on a separate page (which the README now links to) -- see https://cpp-linter.github.io/cpp-linter/cli_args.html This means we no longer have to update 2 copies of the descriptions for the CLI args. The descriptions are now fetched from cpp-linter -h output.

Merging this and releasing it to PyPI will be a big step towards switching to a composite action.

reword the link in README
2bndy5 added 3 commits August 23, 2022 15:17
This uses "indigo" for the doc's header and drawer background color.

This is done so we can use a visible color for
hyperlinks (which uses primary color).
The primary color is set to light-blue for
better contrast in light/dark themes.
@2bndy5 2bndy5 merged commit 950ff0b into main Aug 24, 2022
@2bndy5 2bndy5 deleted the migration branch August 24, 2022 05:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Abstract python sources from cpp-linter-action to cpp-linter repo

4 participants