https://github.com/wingify/vwo-tech-debt-client
This open source library allows you to send your feature flag usage to VWO to help you reduce your tech debt.
https://github.com/wingify/vwo-tech-debt-client
Last synced: about 2 months ago
JSON representation
This open source library allows you to send your feature flag usage to VWO to help you reduce your tech debt.
- Host: GitHub
- URL: https://github.com/wingify/vwo-tech-debt-client
- Owner: wingify
- License: apache-2.0
- Created: 2024-04-22T15:38:20.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-05-03T13:36:33.000Z (about 1 year ago)
- Last Synced: 2025-04-04T16:12:50.228Z (2 months ago)
- Language: Java
- Homepage:
- Size: 2.86 MB
- Stars: 4
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# VWO Tech Debt Client
[](http://www.apache.org/licenses/LICENSE-2.0)
This open source library allows you to send your feature flag usage to VWO to help you reduce your tech debt.
## Requirements
The tech debt client runs as a JAR file, and you can run it either on your local dev environment, or as a Jenkins Job.
You can either use the JAR included in the repo, or you can build it from the source.
## Jenkins Job
You can run the client from a Jenkins job
```jenkins
java -jar sourceFolder="${WORKSPACE}" accountId=${accountId} isReferenceCode=${isReferenceCode} APIToken=${apiToken} repoBranch="${GIT_BRANCH}" repoURL="${GIT_URL}"
```
Variables :
location_of_tech_debt_client - /opt/automata/vwo-techdebt-client.jar (as an example)
GIT_BRANCH, GIT_URL, WORKSPACE - variables available in Jenkins
accountId - VWO accountId
isReferenceCode - set to true if you want to send your code snippets to VWO
APIToken - VWO Developer API Token
## Third-party Resources and Credits
Refer [third-party-attributions.txt](https://github.com/wingify/vwo-tech-debt-client/blob/master/third-party-attributions.txt)
## Authors
* Core Contributor & Maintainer - [rohitesh-wingify](https://github.com/rohitesh-wingify)
## Changelog
Refer [CHANGELOG.md](https://github.com/wingify/vwo-tech-debt-client/blob/master/CHANGELOG.md)
## Contributing
Please go through our [contributing guidelines](https://github.com/wingify/vwo-tech-debt-client/blob/master/CONTRIBUTING.md)
## Code of Conduct
[Code of Conduct](https://github.com/wingify/vwo-tech-debt-client/blob/master/CODE_OF_CONDUCT.md)
## License
[Apache License, Version 2.0](https://github.com/wingify/vwo-tech-debt-client/blob/master/LICENSE)
Copyright 2024 Wingify Software Pvt. Ltd.