isma
/
podcast
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Slim go modules (#32) 

* Slim down Go Modules
* Update docs
This commit is contained in:
Eric Duncan 2020-02-13 18:05:35 -05:00 committed by GitHub
parent 975adb8ec2
commit 4b460c48ee
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 25 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -96,21 +96,25 @@ However, the new 2.x branch, while keeping the same API, is expected break those
bypass the API methods and use the underlying public properties instead. bypass the API methods and use the underlying public properties instead.
### Release Notes ### Release Notes
1.4.1 v1.4.2
* Slim down Go Modules for consumers (#32)
v1.4.1
* Implement fuzz logic testing of exported funcs (#31) * Implement fuzz logic testing of exported funcs (#31)
* Upgrade CICD Pipeline Tooling (#31) * Upgrade CICD Pipeline Tooling (#31)
* Update documentation for 1.x and 2.3 (#31) * Update documentation for 1.x and 2.3 (#31)
* Allow godoc2ghmd to run without network (#31) * Allow godoc2ghmd to run without network (#31)
1.4.0 v1.4.0
* Add Go Modules, Update vendor folder (#26, #25) * Add Go Modules, Update vendor folder (#26, #25)
* Add C.I. GitHub Actions (#25) * Add C.I. GitHub Actions (#25)
* Add additional error checks found by linters (#25) * Add additional error checks found by linters (#25)
* Go Fmt enclosure_test.go (#25) * Go Fmt enclosure_test.go (#25)
1.3.2 v1.3.2
* Correct count len of UTF8 strings (#9) * Correct count len of UTF8 strings (#9)
* Implement duration parser (#8) * Implement duration parser (#8)
@ -118,26 +122,26 @@ bypass the API methods and use the underlying public properties instead.
* Move podcast.go Private Methods to Respected Files (#12) * Move podcast.go Private Methods to Respected Files (#12)
* Allow providing GUID on Podcast (#15) * Allow providing GUID on Podcast (#15)
1.3.1 v1.3.1
* increased itunes compliance after feedback from Apple: * increased itunes compliance after feedback from Apple:
- specified what categories should be set with AddCategory(). - specified what categories should be set with AddCategory().
- enforced title and link as part of Image. - enforced title and link as part of Image.
* added Podcast.AddAtomLink() for more broad compliance to readers. * added Podcast.AddAtomLink() for more broad compliance to readers.
1.3.0 v1.3.0
* fixes Item.Duration being set incorrectly. * fixes Item.Duration being set incorrectly.
* changed Item.AddEnclosure() parameter definition (Bytes not Seconds!). * changed Item.AddEnclosure() parameter definition (Bytes not Seconds!).
* added Item.AddDuration formatting and override. * added Item.AddDuration formatting and override.
* added more documentation surrounding Item.Enclosure{} * added more documentation surrounding Item.Enclosure{}
1.2.1 v1.2.1
* added Podcast.AddSubTitle() and truncating to 64 chars. * added Podcast.AddSubTitle() and truncating to 64 chars.
* added a number of Guards to protect against empty fields. * added a number of Guards to protect against empty fields.
1.2.0 v1.2.0
* added Podcast.AddPubDate() and Podcast.AddLastBuildDate() overrides. * added Podcast.AddPubDate() and Podcast.AddLastBuildDate() overrides.
* added Item.AddImage() to mask some cumbersome addition of IImage. * added Item.AddImage() to mask some cumbersome addition of IImage.
@ -145,11 +149,11 @@ bypass the API methods and use the underlying public properties instead.
* added more examples (mostly around Item struct). * added more examples (mostly around Item struct).
* tweaked some documentation. * tweaked some documentation.
1.1.0 v1.1.0
* Enabling CDATA in ISummary fields for Podcast and Channel. * Enabling CDATA in ISummary fields for Podcast and Channel.
1.0.0 v1.0.0
* Initial release. * Initial release.
* Full documentation, full examples and complete code coverage. * Full documentation, full examples and complete code coverage.

21
doc.go
View File

@ -96,52 +96,55 @@
// //
// Release Notes // Release Notes
// //
// 1.4.1 // v1.4.2
// * Slim down Go Modules for consumers (#32)
//
// v1.4.1
// * Implement fuzz logic testing of exported funcs (#31) // * Implement fuzz logic testing of exported funcs (#31)
// * Upgrade CICD Pipeline Tooling (#31) // * Upgrade CICD Pipeline Tooling (#31)
// * Update documentation for 1.x and 2.3 (#31) // * Update documentation for 1.x and 2.3 (#31)
// * Allow godoc2ghmd to run without network (#31) // * Allow godoc2ghmd to run without network (#31)
// //
// 1.4.0 // v1.4.0
// * Add Go Modules, Update vendor folder (#26, #25) // * Add Go Modules, Update vendor folder (#26, #25)
// * Add C.I. GitHub Actions (#25) // * Add C.I. GitHub Actions (#25)
// * Add additional error checks found by linters (#25) // * Add additional error checks found by linters (#25)
// * Go Fmt enclosure_test.go (#25) // * Go Fmt enclosure_test.go (#25)
// //
// 1.3.2 // v1.3.2
// * Correct count len of UTF8 strings (#9) // * Correct count len of UTF8 strings (#9)
// * Implement duration parser (#8) // * Implement duration parser (#8)
// * Fix Github and GoDocs Markdown (#14) // * Fix Github and GoDocs Markdown (#14)
// * Move podcast.go Private Methods to Respected Files (#12) // * Move podcast.go Private Methods to Respected Files (#12)
// * Allow providing GUID on Podcast (#15) // * Allow providing GUID on Podcast (#15)
// //
// 1.3.1 // v1.3.1
// * increased itunes compliance after feedback from Apple: // * increased itunes compliance after feedback from Apple:
// - specified what categories should be set with AddCategory(). // - specified what categories should be set with AddCategory().
// - enforced title and link as part of Image. // - enforced title and link as part of Image.
// * added Podcast.AddAtomLink() for more broad compliance to readers. // * added Podcast.AddAtomLink() for more broad compliance to readers.
// //
// 1.3.0 // v1.3.0
// * fixes Item.Duration being set incorrectly. // * fixes Item.Duration being set incorrectly.
// * changed Item.AddEnclosure() parameter definition (Bytes not Seconds!). // * changed Item.AddEnclosure() parameter definition (Bytes not Seconds!).
// * added Item.AddDuration formatting and override. // * added Item.AddDuration formatting and override.
// * added more documentation surrounding Item.Enclosure{} // * added more documentation surrounding Item.Enclosure{}
// //
// 1.2.1 // v1.2.1
// * added Podcast.AddSubTitle() and truncating to 64 chars. // * added Podcast.AddSubTitle() and truncating to 64 chars.
// * added a number of Guards to protect against empty fields. // * added a number of Guards to protect against empty fields.
// //
// 1.2.0 // v1.2.0
// * added Podcast.AddPubDate() and Podcast.AddLastBuildDate() overrides. // * added Podcast.AddPubDate() and Podcast.AddLastBuildDate() overrides.
// * added Item.AddImage() to mask some cumbersome addition of IImage. // * added Item.AddImage() to mask some cumbersome addition of IImage.
// * added Item.AddPubDate to simply datetime setters. // * added Item.AddPubDate to simply datetime setters.
// * added more examples (mostly around Item struct). // * added more examples (mostly around Item struct).
// * tweaked some documentation. // * tweaked some documentation.
// //
// 1.1.0 // v1.1.0
// * Enabling CDATA in ISummary fields for Podcast and Channel. // * Enabling CDATA in ISummary fields for Podcast and Channel.
// //
// 1.0.0 // v1.0.0
// * Initial release. // * Initial release.
// * Full documentation, full examples and complete code coverage. // * Full documentation, full examples and complete code coverage.
// //

6
go.mod
View File

@ -3,12 +3,6 @@ module github.com/eduncan911/podcast
go 1.13 go 1.13
require ( require (
github.com/davecgh/go-spew v1.1.1
github.com/dvyukov/go-fuzz v0.0.0-20191206100749-a378175e205c // indirect
github.com/kr/pretty v0.1.0 // indirect
github.com/pkg/errors v0.9.1 github.com/pkg/errors v0.9.1
github.com/pmezard/go-difflib v1.0.0
github.com/stretchr/testify v1.4.0 github.com/stretchr/testify v1.4.0
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect
gopkg.in/yaml.v2 v2.2.8
) )

14
go.sum
View File

@ -1,27 +1,13 @@
github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8= github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/dvyukov/go-fuzz v0.0.0-20191206100749-a378175e205c h1:/bXaeEuNG6V0HeyEGw11DYLW5BGsOPlcVRIXbHNUWSo=
github.com/dvyukov/go-fuzz v0.0.0-20191206100749-a378175e205c/go.mod h1:11Gm+ccJnvAhCNLlf5+cS9KjtbaD5I5zaZpFMsTHWTw=
github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk= github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk=
github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo=
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw= gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10=
gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=