Skip to content

Cleanup cpp_linter source code starting from v2 #95

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.

Sign up for GitHub

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

Jump to bottom
Closed
Tracked by #87
shenxianpeng opened this issue Sep 1, 2022 · 4 comments · Fixed by #96
Closed
Tracked by #87

Cleanup cpp_linter source code starting from v2 #95

shenxianpeng opened this issue Sep 1, 2022 · 4 comments · Fixed by #96
Labels
enhancement New feature or request

Comments

@shenxianpeng
Copy link
Collaborator

Since we have already abstracted python sources from cpp-linter-action to cpp-linter repo, and we'll change action from using docker to composite steps, it's ready to clean up cpp_linter related code starting from v2 release.
@shenxianpeng shenxianpeng added the enhancement New feature or request label Sep 1, 2022
@shenxianpeng shenxianpeng mentioned this issue Sep 1, 2022
Closed
8 tasks
@2bndy5
Copy link
Collaborator

2bndy5 commented Sep 1, 2022

The docs should be altered (or removed), so that the only the README (& possibly the new contributing guidelines) are rendered. The API reference pages will no longer be needed if the python source code is removed. In fact, removing the python sources without altering the docs may actually break docs' build.

@2bndy5
Copy link
Collaborator

2bndy5 commented Sep 1, 2022

The dev-test.yml CI and the coverage badge should go too.

@shenxianpeng
Copy link
Collaborator Author

If #83 is ready to merge, it should be simple to merge it and then clean up the source code to avoid conflicts.

@2bndy5
Copy link
Collaborator

2bndy5 commented Sep 1, 2022

Submitting a review shortly

2bndy5 added a commit that referenced this issue Sep 1, 2022
@2bndy5
remove remnants of python package
cb40c99 
solves #95

- altered docs
   - added the new logo & favicon.
  - changed colors for readability
  - removed API reference pages
  - adds contributing guidelines page
- removed python sources
- removed unit tests
- removed requirements*.txt
- removed gitpod config because
  it was only related to installing python
  dependencies (specifically not for docs)
- removed pre-commit hooks related to python sources
- removed pytest/coverage workflows
- updated README
   - removed coverage badge
   - changed target for docs badge to point to hosted docs
- reduced mkdocs config/requirements accordingly
- changed link to LICENSE to be absolute
  because it was broken from the docs site
@2bndy5 2bndy5 mentioned this issue Sep 1, 2022
Merged
@2bndy5 2bndy5 linked a pull request Sep 1, 2022 that will close this issue
remove remnants of python package #96
Merged
2bndy5 added a commit that referenced this issue Sep 1, 2022
@2bndy5
remove remnants of python package
8c591bd 
solves #95

- altered docs
   - added the new logo & favicon.
  - changed colors for readability
  - removed API reference pages
  - adds contributing guidelines page
- removed python sources
- removed unit tests
- removed requirements*.txt
- removed gitpod config because
  it was only related to installing python
  dependencies (specifically not for docs)
- removed pre-commit hooks related to python sources
- removed pytest/coverage workflows
- updated README
   - removed coverage badge
   - changed target for docs badge to point to hosted docs
- reduced mkdocs config/requirements accordingly
- changed link to LICENSE to be absolute
  because it was broken from the docs site
- adjust mkdocs CI
2bndy5 added a commit that referenced this issue Sep 1, 2022
@2bndy5
remove remnants of python package
90ec2f7 
solves #95

- altered docs
   - added the new logo & favicon.
  - changed colors for readability
  - removed API reference pages
  - adds contributing guidelines page
- removed python sources
- removed unit tests
- removed requirements*.txt
- removed gitpod config because
  it was only related to installing python
  dependencies (specifically not for docs)
- removed pre-commit hooks related to python sources
- removed pytest/coverage workflows
- updated README
   - removed coverage badge
   - changed target for docs badge to point to hosted docs
- reduced mkdocs config/requirements accordingly
- changed link to LICENSE to be absolute
  because it was broken from the docs site
- adjust mkdocs CI
- adjust test-repo triggers in run-test.yml CI workflow
2bndy5 added a commit that referenced this issue Sep 1, 2022
@2bndy5
remove remnants of python package (#96)
49c2eb9 
solves #95

- altered docs
   - added the new logo & favicon.
  - changed colors for readability
  - removed API reference pages
  - adds contributing guidelines page
- removed python sources
- removed unit tests
- removed requirements*.txt
- removed gitpod config because
  it was only related to installing python
  dependencies (specifically not for docs)
- removed pre-commit hooks related to python sources
- removed pytest/coverage workflows
- updated README
   - removed coverage badge
   - changed target for docs badge to point to hosted docs
- reduced mkdocs config/requirements accordingly
- changed link to LICENSE to be absolute
  because it was broken from the docs site
- adjust mkdocs CI
- adjust test-repo triggers in run-test.yml CI workflow
@2bndy5 2bndy5 closed this as completed in #96 Sep 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
No open projects
cpp-linter as composite action
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

remove remnants of python package cpp-linter/cpp-linter-action
2 participants
@shenxianpeng @2bndy5