From 307eb259b8c990609866fdf5144ee9187d86d2a3 Mon Sep 17 00:00:00 2001 From: Cory Slep Date: Wed, 13 Jun 2018 23:23:46 +0200 Subject: [PATCH] Update README and other files for 0.1.1 --- CHANGELOG | 42 ++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 6 +++++- README.md | 20 +++++++++++++------- 3 files changed, 60 insertions(+), 8 deletions(-) create mode 100644 CHANGELOG diff --git a/CHANGELOG b/CHANGELOG new file mode 100644 index 0000000..649d7da --- /dev/null +++ b/CHANGELOG @@ -0,0 +1,42 @@ +v0.1.1 2018-06-13 + +* Begin SocialAPI unofficial implementation report. +* Improved HTTP header detection for ActivityPub requests. +* Activities added to outboxes are now Set (in addition to the outbox itself). +* Fixed panic where the 'bcc' and 'bto' properties were improperly guarded. +* Fixed authn/authz shadowing when serving ActivityStream objects, causing only + HTTP Signatures to be enforced. +* Under certain circumstances, IRIs will be fetched when an Add Activity is + received. This behavior is a stepping stone towards a comprehensive + solution in a future patch. +* SocialAPI Undo Activity has actors enforced the same way as the FederatedAPI. +* IRI normalization: Objects, Activities, and Links will no longer be duplicated + when added to Collection types. Instead, IRIs are added. +* Serving ActivityStream objects will now remove the 'bcc' and 'bto' properties. +* Serving a Tombstone ActivityStream response now uses the HTTP 410 Gone status + code. +* The 'vocab' and 'streams' subpackages now generate code to multiple files + instead of a single large one. +* The 'deliverer' subpackage now has test coverage. + +v0.1.0 2018-05-30 + +* Initial release of the 'deliverer' subpackage. +* Initial release of the 'pub' subpackage. +* Initial release of the 'streams' subpackage. +* Initial release of the 'tools' subpackage. +* Initial release of the 'vocab' subpackage. +* Support for ActivityStream static types in Go. +* Support for ActivityStream serialization and deserialization. +* Support for ActivityPub POST and GET to actor inboxes. +* Support for ActivityPub POST and GET to actor outboxes. +* Support for SocialAPI, FederatedAPI, or both for inbox and outboxes. +* Support for ActivityPub GET to fetch ActivityStreams. +* Support for HTTP Signature verification. +* Support for basic SocialAPI Activity behaviors. +* Support for basic FederatedAPI Activity behaviors. +* Support for Application-customized authn/authz behaviors. +* Support for Tombstone for Delete Activities. +* Test 'vocab' against examples in the spec. +* Test 'streams' against the test repository. +* Test 'pub' with over >100 end-to-end black box tests. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 65e0bd6..c160576 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -57,7 +57,11 @@ Yes! ### Compilation of `vocab` is tough on time and resources! -See [#42](https://github.com/go-fed/activity/issues/42). +The `vocab` and `streams` packages are code generated on order of hundreds of +thousands to a million lines long. If using Go 1.9 or before, use `go install` +or `go build -i` to cache the build artifacts and do incremental builds. + +Additionally, see [#42](https://github.com/go-fed/activity/issues/42). ### Can I financially support this effort? diff --git a/README.md b/README.md index 50f3736..f0a0c3f 100644 --- a/README.md +++ b/README.md @@ -17,14 +17,24 @@ Federated, or both kinds of ActivityPub applications just work. ## Status -Version 0.1.0 of this library is ready for use. +**0.1.1** ([Semantic Versioning](https://semver.org/)) -There is not an implementation report available... yet! +There is no official implementation report available... yet! + +[Unofficial implementation reports are available in issue #46](https://github.com/go-fed/activity/issues/46). + +Please see CHANGELOG for changes between versions. + +## Getting Started See each subdirectory for its own README for further elaboration. The recommended reading order is `vocab`, `streams`, and then `pub`. Others are optional. +## How can I get help, file issues, or contribute? + +Please see the CONTRIBUTING.md file! + ## How well tested are these libraries? I took great care to add numerous tests using examples directly from @@ -49,11 +59,7 @@ Passing familiarity with ActivityStreams and ActivityPub is recommended. ## FAQ -*Why does compilation take so long?* - -The `vocab` and `streams` packages are code generated on order of hundreds of -thousands to a million lines long. If using Go 1.9 or before, use `go install` -or `go build -i` to cache the build artifacts and do incremental builds. +Please see the CONTRIBUTING.md file! ## Useful References