prepare for the first release (#264)
First, write a changelog file. We will use GitHub releases, but the content in those is not stored in git nor is it portable or machine readable. The canonical place for the changelog is here. Second, disable 'garble test', as it is entirely broken. Issue #241 tracks fixing and re-enabling it, which will most likely happen for the next release. Third, disable the undocumented 'garble list'. This was added as part of 'garble reverse', but it never got used. I can't think of any reason why any end user would prefer it over 'go list', either. 'garble reverse' remains enabled, but undocumented as it isn't fully functional yet. Until it supports position information, it's not particularly useful to end users. But it's not broken either, so it can remain where it is. Fourth, update the '-tiny' size reduction numbers in the README. Since we removed the in-place modification of object files, we are no longer able to do such an aggressive stripping of info. Garble itself drops in size by 2%, so replace the old 6-10% estimate by 2-5%. We probably will gain some of this back in the near future. Finally, fix the indentation formatting of the README to consistently use tabs.pull/265/head
parent
1267e2eced
commit
2a9c0b7bf4
@ -0,0 +1,20 @@
|
||||
# Changelog
|
||||
|
||||
## Unreleased
|
||||
|
||||
This is the first release of Garble. It supports Go 1.15.x and 1.16.x.
|
||||
|
||||
It ships all the major features that have worked for the past year, including:
|
||||
|
||||
* Obfuscation of all names, except methods and reflect targets
|
||||
* Obfuscation of package import paths and position information
|
||||
* Stripping of build and module information
|
||||
* Support for Go modules
|
||||
* Reproducible and cacheable builds
|
||||
* Stripping of extra information via `-tiny`
|
||||
* Literal obfuscation via `-literals`
|
||||
|
||||
Known bugs:
|
||||
|
||||
* obfuscating the standard library with `GOPRIVATE=*` is not well supported yet
|
||||
* `garble test` is temporarily disabled, as it is currently broken
|
Loading…
Reference in New Issue