govuk_document_types 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 341f515aba3de2b96cc34b6e5cc607cbf7d6933a
-  data.tar.gz: 73e20dd83fd9e8323ea1d05f6ed0402ee72b3c02
+  metadata.gz: 2db3d7d1d6a7c3adab93331ed8c258c66a957087
+  data.tar.gz: cd3d636494435645b78a9a0fd73783e216952d33
 SHA512:
-  metadata.gz: d140e20e39e40a0f88c694c2e98a4718b2372f652079474af40343041244d85293258d092294bd5a798fcea90726d81fd64f15da4e74dd8e80b75a5474847917
-  data.tar.gz: 7ec967069cb7675cb1eca439c8e50b1d1b79fd71f0f960bbf9b59e1bff9b0d68fedd4eb9b189ecd42fabc3c3a172ebd7131f2ecb658825f6f4131cd7312bf53a
+  metadata.gz: 61b658b442e3b405fee966043c8ae21e8be066fb70402080d8d03a9e4aa2392b56cda9769dd66620c2aba00964e3afcdf7a117d11985d5b3cf367ef922aa2190
+  data.tar.gz: 2f0ce0eebc900c0ffe2bde644073f308a91e7cfb5dc265520c34d3396f726ed3aec61dd894e6e92c85a6294e5a4af0c4613fb62b2d6ddb505651f07a9d559694

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.1.5
+
+* Add email_document_supertype > announcements > world_news_story to fix some
+subscriber list matching problems between govuk-delivery and email-alert-api.
+
 # 0.1.4
 
 * Add "email" and "government" supertypes to help with the whitehall email migration to EmailAlertApi

data/LICENSE.txt

@@ -1,21 +1,19 @@
-The MIT License (MIT)
+Copyright (C) 2017 Crown copyright (Government Digital Service)
 
-Copyright (c) 2017 Tijmen Brommet
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,41 +1,40 @@
-# GovukDocumentTypes
+# GOV.UK document types
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/govuk_document_types`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem contains the "document supertypes" for GOV.UK. Supertypes are groupings
+of document types.
 
-TODO: Delete this and the text above, and describe your gem
+https://docs.publishing.service.gov.uk/document-types.html
 
-## Installation
+This gem is only to be used in [publishing-api][publishing-api] and
+[rummager][rummager]. **Don't use it in your project**.
 
-Add this line to your application's Gemfile:
+## How to add a supertype
 
-```ruby
-gem 'govuk_document_types'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install govuk_document_types
-
-## Usage
+1. Add it to [data/supertypes.yml](data/supertypes.yml) in this gem and release a new version
+2. [Add the supertype][rummager-pr] in Rummager so that it can be indexed and searched with. Bump the gem in Rummager.
+3. [Add the type to content-schemas][schemas-pr]
+4. [Add the type to the content-store][content-store-pr]
+5. Bump the gem version in [publishing-api][publishing-api]
 
-TODO: Write usage instructions here
+## How to update a supertype
 
-## Development
+1. Update [data/supertypes.yml](data/supertypes.yml) in this gem and release a new version.
+2. Bump the gem version in [rummager][rummager]. Rummager's nightly re-indexing will pick up your changes.
+3. Bump the gem version in [publishing-api][publishing-api]. All documents have to be sent to the content-store again for your changes to be picked up.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/govuk_document_types.
+## Running the test suite
 
+```
+bundle exec rake
+```
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+[MIT License](LICENSE.txt)
+
+[rummager-pr]: https://github.com/alphagov/rummager/pull/756
+[schemas-pr]: https://github.com/alphagov/govuk-content-schemas/pull/551
+[content-store-pr]: https://github.com/alphagov/content-store/pull/268
 
+[publishing-api]: https://github.com/alphagov/publishing-api
+[rummager]: https://github.com/alphagov/rummager

data/data/supertypes.yml

@@ -84,13 +84,13 @@ email_document_supertype:
         - transparency
     - id: "announcements"
       document_types:
-        - announcement
         - fatality_notice
         - government_response
         - news_story
         - oral_statement
         - press_release
         - speech
+        - world_news_story
         - written_statement
 
 government_document_supertype:
@@ -169,7 +169,6 @@ government_document_supertype:
     - id: news-stories
       document_types:
         - news_story
-        - announcement
     - id: fatality-notices
       document_types:
         - fatality_notice

data/lib/govuk_document_types/version.rb

@@ -1,3 +1,3 @@
 module GovukDocumentTypes
-  VERSION = "0.1.4".freeze
+  VERSION = "0.1.5".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_document_types
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-17 00:00:00.000000000 Z
+date: 2017-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Gem to share document type groupings