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

CVE Binary Tool Release Notes page hasn't been updated for v3.3 and now v3.4 was just made #4458

Closed
tzirn opened this issue Sep 20, 2024 · 6 comments · Fixed by #4464
Closed
Labels
bug Something isn't working documentation Documentation changes good first issue Good for newcomers

Comments

@tzirn
Copy link

tzirn commented Sep 20, 2024

Description

The CVE Binary Tool Release Notes page wasn't updated for v3.3 and now v3.4 has been released.

To reproduce

Steps to reproduce the behavior:

  1. go to https://cve-bin-tool.readthedocs.io/en/latest/RELEASE.html
  2. see the last version to be documented is v3.2

Expected behavior: that v3.3 release would have been documented
Actual behavior: release notes are missing for v3.3 ( and please also add in v3.4 now)

Version/platform info

N/A

Anything else?

I was asked to do some v3.4r* preliminary testing and found the options/parameters were changed since v3.3 so please make sure when the documentation is updated for 3.4 that the change in parameter/options for the tool command are documented and also the fact that with the move to *.json triage files -previous users can just copy their *.vex triage file to *.json and it will work.
Thanks so much!

@tzirn tzirn added the bug Something isn't working label Sep 20, 2024
@tzirn
Copy link
Author

tzirn commented Sep 20, 2024

This is the manual that needs updating https://cve-bin-tool.readthedocs.io/en/latest/MANUAL.html

@terriko
Copy link
Contributor

terriko commented Sep 20, 2024

The release notes thing is manually done and has always lagged months (or years) behind what's in github's releases list. I"m not even sure if I should maintain it or remove it or automate it.

I'm going to mark this as a good first issue since someone just needs to cut/paste stuff over into the release notes file.

If anyone wants a more exciting task, we could use some automation so what's in the release notes gets copied into the appropriate file (preferably not just during release, but during any update.)

@terriko terriko added good first issue Good for newcomers documentation Documentation changes labels Sep 20, 2024
@uday-rana
Copy link
Contributor

I'd like to try this.

@tzirn
Copy link
Author

tzirn commented Sep 23, 2024

I'd like to try this.

Thanks! any chance that includes updating the user manual too? :-)

@uday-rana
Copy link
Contributor

I'd like to try this.

Thanks! any chance that includes updating the user manual too? :-)

Sure, what exactly would you like me to update? As far as I can tell it's been updated for v3.4. #4443

@tzirn
Copy link
Author

tzirn commented Sep 24, 2024

@uday-rana looks like the user manual was updated right after I had last loaded the page. The parameters that were changed are now updated.
Thank you for taking on the release notes for the 3.3 and 3.4 version as it will be important that these release notes list that 3.4 changed the parameters AND that vex input files aren't supported anymore but can just be copied to *.json and still used. 4421 notes the loss of *.vex file usage.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Documentation changes good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants