Skip to content
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.

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

Moving toward v3 #283

Open
1 of 3 tasks
2bndy5 opened this issue Nov 27, 2024 · 0 comments
Open
1 of 3 tasks

Moving toward v3 #283

2bndy5 opened this issue Nov 27, 2024 · 0 comments
Labels
enhancement New feature or request help wanted Extra attention is needed major A major version bump

Comments

@2bndy5
Copy link
Collaborator

2bndy5 commented Nov 27, 2024

This is a checklist of tasks that should be implemented in v3. Work for this shall live in the v3 branch until ready for deployment.

  • switch to cpp-linter-rs project. We could use a standalone binary instead of the python binding, but dependabot would not know what version is used. Alternatively, we could use the node.js binding, but packaging that in cpp-linter-action needs further investigation (because of native distributions on npmjs.org).
  • switch clang-tools installer to non-python dependent project. I have not started development on this (yet). The intention here is to remove the dependence on a python runtime.
  • Write a migration guide for v2 -> v3 and v1 -> v3. This should include changes to inputs only. Users can find information about outputs in our regular documentation because there are no breaking changes in the outputs.

Backward compatibility

We can retain v2 in a non-default branch (named v2). This would allow current workflows to keep working with

- uses: cpp-linter/cpp-linter-action@v2

Dependabot updates will not update non-default branches, but that's ok. The cpp-linter-rs project will begin uploading releases to pypi, so the cpp-linter version on v2 branch should be pinned to the last pure-python release.

@2bndy5 2bndy5 added enhancement New feature or request major A major version bump help wanted Extra attention is needed labels Nov 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed major A major version bump
Projects
None yet
Development

No branches or pull requests

1 participant