Prep for v1.2.2 release (#93)

* Generate changelog * Update README to document release process
yalelibrary · Jun 8, 2020 · 546bc48 · 546bc48
1 parent 3943652
commit 546bc48
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 88 deletions.
diff --git a/.github_changelog_generator b/.github_changelog_generator
@@ -1,2 +1,2 @@
 unreleased=true
-future-release=1.2.1
+future-release=1.2.2
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,11 +1,24 @@
 # Changelog
 
-## [1.2.1](https://github.com/yalelibrary/yul-dc-blacklight/tree/1.2.1) (2020-06-05)
+## [1.2.2](https://github.com/yalelibrary/yul-dc-blacklight/tree/1.2.2) (2020-06-08)
 
-[Full Changelog](https://github.com/yalelibrary/yul-dc-blacklight/compare/v1.2.0...1.2.1)
+[Full Changelog](https://github.com/yalelibrary/yul-dc-blacklight/compare/v1.2.1...1.2.2)
 
 **Merged pull requests:**
 
+- Silence deprecations from Blacklight [\#92](https://github.com/yalelibrary/yul-dc-blacklight/pull/92) ([tilthouse](https://github.com/tilthouse))
+- Add a link for Language on the show page [\#91](https://github.com/yalelibrary/yul-dc-blacklight/pull/91) ([FCRodriguez7](https://github.com/FCRodriguez7))
+- Bump websocket-extensions from 0.1.3 to 0.1.4 [\#90](https://github.com/yalelibrary/yul-dc-blacklight/pull/90) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump websocket-extensions from 0.1.4 to 0.1.5 [\#89](https://github.com/yalelibrary/yul-dc-blacklight/pull/89) ([dependabot[bot]](https://github.com/apps/dependabot))
+- 190 add author facet [\#88](https://github.com/yalelibrary/yul-dc-blacklight/pull/88) ([K8Sewell](https://github.com/K8Sewell))
+
+## [v1.2.1](https://github.com/yalelibrary/yul-dc-blacklight/tree/v1.2.1) (2020-06-05)
+
+[Full Changelog](https://github.com/yalelibrary/yul-dc-blacklight/compare/v1.2.0...v1.2.1)
+
+**Merged pull requests:**
+
+- Release prep for 1.2.1 [\#87](https://github.com/yalelibrary/yul-dc-blacklight/pull/87) ([bess](https://github.com/bess))
 - Put the blacklight version in the footer [\#86](https://github.com/yalelibrary/yul-dc-blacklight/pull/86) ([bess](https://github.com/bess))
 - Collapse chrome installation into a single docker layer [\#85](https://github.com/yalelibrary/yul-dc-blacklight/pull/85) ([bess](https://github.com/bess))
 - Autogenerate changelog and release notes [\#84](https://github.com/yalelibrary/yul-dc-blacklight/pull/84) ([bess](https://github.com/bess))

diff --git a/README.md b/README.md
@@ -90,82 +90,6 @@ This is one of the microservices applications that form the Yale digital library
   SOLR_CORE=blacklight-core bundle exec rake yale:index_fixture_data
   ```
 
-## Pushing new images to Dockerhub
-
-### If you've made modifications to Dockerfile.base:
-
-1. Update the base services
-
-  ```bash
-  docker-compose build base
-  ```
-
-  - When the base services are finished building the last line should say "Successfully tagged yalelibraryit/dc-blacklight-base:`<image-name>`". e.g.:
-
-    ```bash
-    Successfully tagged yalelibraryit/dc-blacklight-base:v1.0.0
-    ```
-
-  - That tagged image being referenced is the newest image that's currently available on DockerHub. You can verify that by:
-
-    - Going to <https://hub.docker.com/orgs/yalelibraryit/repositories>
-    - Clicking the arrow icon at the far right of the line that says "yalelibraryit / dc-blacklight-base"
-    - Selecting the "Tags" button next to "General"
-    - Sort by "Newest" in the drop down on the right side of the window
-
-2. Create a new image tag from the updated base services build
-
-  - The `docker tag` command takes 2 arguments:
-
-    - The first argument is the newest tag that's currently in DockerHub that you saw above in step 1
-    - The second argument is the tag you want to assign the new image
-    - In order to properly tag the new image, increment the appropriate place value by one. e.g.:
-
-      ```bash
-      docker tag yalelibraryit/dc-blacklight-base:v1.0.0 yalelibraryit/dc-blacklight-base:v1.0.1
-      ```
-
-3. Sign in to Docker from your command line
-
-  ```bash
-  docker login
-  ```
-
-  - You'll be prompted to enter your Docker username and password
-
-4. Push the base image with your incremented version tag. e.g.:
-
-  ```bash
-  docker push yalelibraryit/dc-blacklight-base:v1.0.1
-  ```
-
-5. Build the blacklight services
-
-  ```bash
-  docker-compose build
-  ```
-
-  - When the blacklight services are complete there will be a line that says "Successfully tagged yalelibraryit/dc-blacklight:`<image-name>`". e.g.:
-
-    ```bash
-    Successfully tagged yalelibraryit/dc-blacklight:master
-    ```
-
-6. Create a new image tag from the updated blacklight services build
-
-  - Your first argument is the full tag that you saw in step 5
-  - The secomd argument replaces the `master` image name, with the image name we used in step 2\. e.g.:
-
-    ```bash
-    docker tag yalelibraryit/dc-blacklight:master yalelibraryit/dc-blacklight:v1.0.1
-    ```
-
-7. Push the blacklight image with your incremented version tag. e.g.:
-
-  ```bash
-  docker push yalelibraryit/dc-blacklight:v1.0.1
-  ```
-
 ## Using the Makefile
 
 You can also use the Makefile to build an image locally, and/or push it to dockerhub:
@@ -201,15 +125,19 @@ IIIF_MANIFESTS_BASE_URL=http://localhost/manifests/
 
 In order to prevent search engine crawling of the system before it's ready to launch, we use HTTP password protection. This is set via environment variables. Set `HTTP_PASSWORD_PROTECT='true'` to enable this feature. Set `HTTP_PASSWORD_PROTECT='false'` to disable this feature. Set the login and password via environment variables `HTTP_USERNAME` and `HTTP_PASSWORD`
 
-## Auto-generate changelog
-
-1. Increment the version number in `.github_changelog_generator`
-2. github_changelog_generator --user yalelibrary --project yul-dc-blacklight --token $YOUR_GITHUB_TOKEN
+## Releasing a new version
 
-# Customizing Blacklight:
+1. Decide on a new version number. We use [semantic versioning](https://semver.org/).
+2. Update the version number in `.github_changelog_generator`
+3. github_changelog_generator --user yalelibrary --project yul-dc-blacklight --token $YOUR_GITHUB_TOKEN
+4. Commit and merge the changes you just made.
+5. Once those changes are merged to the `master` branch, in the github web UI go to `Releases` and tag a new release with the right version number. Paste in the release notes for this version from the changelog you generated. In the release notes, split out `Features`, `Bug Fixes`, and `Other`
+6. Once the CI build has completed for `master`, tag and push a docker hub image with the same release number:
 
-There are many ways to override specific behaviors and views in Blacklight. Because Blacklight is distributed as a Rails engine-based gem, all customization of Blacklight behavior should be done within your application by overriding Blacklight-provided behaviors with your own.
+  ```
+  docker pull yalelibraryit/dc-blacklight:f93089f70e18d6c6d77ee1a6b3b4866b6d284078 <-- the tag created by circleci
+  docker tag yalelibraryit/dc-blacklight:f93089f70e18d6c6d77ee1a6b3b4866b6d284078 yalelibraryit/dc-blacklight:v1.2.1 <-- the new, semantically versioned tag
+  docker push yalelibraryit/dc-blacklight:v1.2.1 <-- now our semantically versioned tag will be available from docker hub
+  ```
 
-- To modify this text, you need to [override the Blacklight-provided view](http://guides.rubyonrails.org/engines.html#improving-engine-functionality). You can copy this file, located in the blacklight gem: `/usr/local/rvm/gems/ruby-2.6.5/gems/blacklight-7.7.0/app/views/catalog/_home_text.html.erb` to your own application: `/home/app/webapp/app/views/catalog/_home_text.html.erb`
-- [Index your own data](https://github.com/projectblacklight/blacklight/wiki/Indexing-your-data-into-solr) into Solr
-- [Configure Blacklight](https://github.com/projectblacklight/blacklight/wiki#blacklight-configuration) to match your data and user-experience needs
+7. Update `yul-dc-camerata` with the new version of blacklight and submit a PR.