Adds an automatic changelog generator

CHANGELOG.md

@@ -1,8 +1,65 @@
 # Changelog
 
-## Unreleased
-
-_nothing_
+## [3.0.0](https://github.com/QutEcoacoustics/baw-server/tree/3.0.0) (2020-07-28)
+
+[Full Changelog](https://github.com/QutEcoacoustics/baw-server/compare/2.0.1...3.0.0)
+
+**Implemented enhancements:**
+
+- Missing site model details [\#453](https://github.com/QutEcoacoustics/baw-server/issues/453)
+- Missing tags parameters [\#436](https://github.com/QutEcoacoustics/baw-server/issues/436)
+- Missing generic sites route [\#431](https://github.com/QutEcoacoustics/baw-server/issues/431)
+- Implement Progress API [\#348](https://github.com/QutEcoacoustics/baw-server/issues/348)
+- Update database schema to accommodate citizen science [\#346](https://github.com/QutEcoacoustics/baw-server/issues/346)
+- Allow removing an image from a site or project [\#315](https://github.com/QutEcoacoustics/baw-server/issues/315)
+- Systematic check of dates & times, ensuring timezone formatting [\#279](https://github.com/QutEcoacoustics/baw-server/issues/279)
+- By permission keyword arguments [\#481](https://github.com/QutEcoacoustics/baw-server/pull/481) ([Allcharles](https://github.com/Allcharles))
+- Basic shallow site routes [\#478](https://github.com/QutEcoacoustics/baw-server/pull/478) ([Allcharles](https://github.com/Allcharles))
+- PR Template [\#476](https://github.com/QutEcoacoustics/baw-server/pull/476) ([Allcharles](https://github.com/Allcharles))
+- Rename taxanomic to taxonomic [\#475](https://github.com/QutEcoacoustics/baw-server/pull/475) ([Allcharles](https://github.com/Allcharles))
+- Upgrades to Rails 6 [\#470](https://github.com/QutEcoacoustics/baw-server/pull/470) ([atruskie](https://github.com/atruskie))
+- Missing tag model details [\#465](https://github.com/QutEcoacoustics/baw-server/pull/465) ([Allcharles](https://github.com/Allcharles))
+- Missing site model details [\#463](https://github.com/QutEcoacoustics/baw-server/pull/463) ([Allcharles](https://github.com/Allcharles))
+- Media public access and tests [\#404](https://github.com/QutEcoacoustics/baw-server/pull/404) ([atruskie](https://github.com/atruskie))
+
+**Fixed bugs:**
+
+- Tag model is\_taxonomic spelling mistake [\#466](https://github.com/QutEcoacoustics/baw-server/issues/466)
+- New tag API route missing notes input [\#464](https://github.com/QutEcoacoustics/baw-server/issues/464)
+- A NoMethodError occurred in errors\#route\_error: [\#405](https://github.com/QutEcoacoustics/baw-server/issues/405)
+- Incorrect current page link when there are zero items  [\#378](https://github.com/QutEcoacoustics/baw-server/issues/378)
+- paging links not working on get filter requests [\#376](https://github.com/QutEcoacoustics/baw-server/issues/376)
+- Incorrect default order for dataset items [\#368](https://github.com/QutEcoacoustics/baw-server/issues/368)
+- Bug: NoMethodError occurred in dataset\_items\#create [\#366](https://github.com/QutEcoacoustics/baw-server/issues/366)
+- Add better error messages for bad content type headers [\#361](https://github.com/QutEcoacoustics/baw-server/issues/361)
+- CSV export for annotations includes leading spaces in headers [\#340](https://github.com/QutEcoacoustics/baw-server/issues/340)
+- Timezone hour:minutes display to the right of timezone name appears to be formatted incorrectly [\#336](https://github.com/QutEcoacoustics/baw-server/issues/336)
+- Exception when determining access permissions to a site [\#333](https://github.com/QutEcoacoustics/baw-server/issues/333)
+
+**Closed issues:**
+
+- Missing assign sites route [\#447](https://github.com/QutEcoacoustics/baw-server/issues/447)
+- Missing annotations route [\#445](https://github.com/QutEcoacoustics/baw-server/issues/445)
+- Missing type of tag route [\#441](https://github.com/QutEcoacoustics/baw-server/issues/441)
+- Missing bookmarks route [\#440](https://github.com/QutEcoacoustics/baw-server/issues/440)
+- Failing sites filter route [\#437](https://github.com/QutEcoacoustics/baw-server/issues/437)
+- Alternative route for progress events that does not require a dataset\_item\_id [\#371](https://github.com/QutEcoacoustics/baw-server/issues/371)
+- Remove timezone configuration for brisbane [\#24](https://github.com/QutEcoacoustics/baw-server/issues/24)
+
+**Merged pull requests:**
+
+- Bump json from 1.8.6 to 2.3.1 [\#482](https://github.com/QutEcoacoustics/baw-server/pull/482) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Rswag - adds the ability to generate documentation for the API [\#479](https://github.com/QutEcoacoustics/baw-server/pull/479) ([atruskie](https://github.com/atruskie))
+- Bump rack from 1.4.1 to 2.2.3 in /lib/gems/resque-status [\#473](https://github.com/QutEcoacoustics/baw-server/pull/473) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump nokogiri from 1.6.1 to 1.10.10 in /lib/gems/resque-status [\#472](https://github.com/QutEcoacoustics/baw-server/pull/472) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump rake from 10.1.1 to 13.0.1 in /lib/gems/resque-status [\#471](https://github.com/QutEcoacoustics/baw-server/pull/471) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump rack from 1.6.11 to 1.6.12 [\#422](https://github.com/QutEcoacoustics/baw-server/pull/422) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Citizen science [\#381](https://github.com/QutEcoacoustics/baw-server/pull/381) ([peichins](https://github.com/peichins))
+- removed leading space in csv column header names [\#379](https://github.com/QutEcoacoustics/baw-server/pull/379) ([peichins](https://github.com/peichins))
+- Feature progress events endpoints [\#372](https://github.com/QutEcoacoustics/baw-server/pull/372) ([peichins](https://github.com/peichins))
+- Checks that post params is not empty for update and create [\#369](https://github.com/QutEcoacoustics/baw-server/pull/369) ([peichins](https://github.com/peichins))
+
+# Old Changelog
 
 ## [Release 2.0.1](https://github.com/QutBioacoustics/baw-server/releases/tag/2.0.1)
 
@@ -50,7 +107,7 @@ _nothing_
 ## [Release 1.4.0](https://github.com/QutBioacoustics/baw-server/releases/tag/1.4.0)
 
 - 2018-02-21
-  - baw-server can now serve analysis result items from SQLite 3 files. This functionality will be used to 
+  - baw-server can now serve analysis result items from SQLite 3 files. This functionality will be used to
     serve zooming spectrogram image tiles. See:
     - [da5f35f](https://github.com/QutEcoacoustics/baw-server/commit/da5f35f7778ce8e4ad0986861c77ee375845b05f)
     - [94cd57b](https://github.com/QutEcoacoustics/baw-server/commit/94cd57bb8be33913092585a941d2aacee044e096)
@@ -82,11 +139,11 @@ _nothing_
     See [7af8cad](https://github.com/QutBioacoustics/baw-server/commit/7af8cadea71d0e45bc374c5161760ec253a6add7)
     - Adds owner user to project show and permissions pages
     See [e26a8e4](https://github.com/QutBioacoustics/baw-server/commit/e26a8e463ea607e00cdc46f018c6cf5329f34c66)
-  
+
 ## [Release 1.2.2](https://github.com/QutBioacoustics/baw-server/releases/tag/1.2.2)
 
 - 2017-02-24
-    - Fixed bugs with site/project permissions - owners can once again create new sites. Further updated site new 
+    - Fixed bugs with site/project permissions - owners can once again create new sites. Further updated site new
     permissions to match specification.
     See [#328](https://github.com/QutBioacoustics/baw-server/issues/328)
 
@@ -101,22 +158,22 @@ _nothing_
  - 2017-02-16
    - Added support for rendering markdown partials
    - Refactored existing instance partials and added a new instance partial for
-   the credits page.  
+   the credits page.
 
 ## [Release 1.1.0](https://github.com/QutBioacoustics/baw-server/releases/tag/1.1.0)
 
 Our major new feature in this release is support for user based analysis-jobs!
  - 2017-02-01
    - Brand new design for our secondary navigation menu. Should be much easier
-   for users to navidate through our menus now. 
+   for users to navidate through our menus now.
    See [#313](https://github.com/QutBioacoustics/baw-server/pull/313)
  - 2017-01-23
    - Fixed an important bug that prevented high quality audio data from being
    sent to users on the listen page. There were several bugs in the byte
    range request code.
    See [#319](https://github.com/QutBioacoustics/baw-server/pull/319)
  - 2017-01-06
-   - Fix flash notifications. A notification consisting of _true_ no longer 
+   - Fix flash notifications. A notification consisting of _true_ no longer
    flashes up when a user comes back to the site with an expires session.
    See [#242](https://github.com/QutBioacoustics/baw-server/issues/242)
  - 2016-12-11
@@ -139,7 +196,7 @@ Our major new feature in this release is support for user based analysis-jobs!
  - 2016-09-16
    - Added support for partial payloads for analysis jobs items
    See [5f96b96](https://github.com/QutBioacoustics/baw-server/commit/5f96b963480c3192533759f9fdf8fa2cfb08f1f0)
-- 
+-
  - 2016-09-13
    - Updated gems [6e469cf](https://github.com/QutBioacoustics/baw-server/commit/6e469cf4be7e16ce632f5b380e7c9101fea36bdb)
  - 2016-08-10
@@ -149,20 +206,20 @@ Our major new feature in this release is support for user based analysis-jobs!
     See [#301](https://github.com/QutBioacoustics/baw-server/issues/301)
  - 2016-08-03
    - Feature: Analysis Jobs items integration. Analysis jobs have been setup and their complete workflows tested and integrated. See [#300](https://github.com/QutBioacoustics/baw-server/pull/300)
-     
+
 ## [Release 0.19.2](https://github.com/QutBioacoustics/baw-server/releases/tag/0.19.2) (2016-06-26)
 
  - 2016-06-21
    - Fixed critical auth bug for analysis results endpoint [#294](https://github.com/QutBioacoustics/baw-server/issues/294)
  - 2016-06-20
    - Bug fixes for processing and working with timezone fields. API now automatically fixes up ill-
      formatted timezone entries in the database. [52866cd](https://github.com/QutBioacoustics/baw-server/commit/52866cd371d3438c8c63e8d1b32a4af8796fd895)
-     
+
 ## [Release 0.19.1](https://github.com/QutBioacoustics/baw-server/releases/tag/0.19.1) (2016-06-17)
 
  - 2016-06-11
    - Fixed outdated reference to baw-workers[ebeaab5](https://github.com/QutBioacoustics/baw-server/commit/ebeaab569f85bad22325c01628e47118ac7662f6)
-     
+
 ## [Release 0.19.0](https://github.com/QutBioacoustics/baw-server/releases/tag/0.19.0) (2016-06-17)
 
  - 2016-06-11
@@ -422,3 +479,6 @@ Our major new feature in this release is support for user based analysis-jobs!
  - 2014-12-16: fixed problems with sign up form
 
 ## Started 2014-12-28.
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

Gemfile

@@ -189,26 +189,12 @@ group :development do
   gem 'i18n-tasks', '~> 0.9.0'
   gem 'notiffany', '~> 0.1.0'
   gem 'rack-mini-profiler', '>= 2.0.2'
-  gem 'rubocop', require: false
-
-  # for cleaning up Rails apps
-  # gem 'traceroute', require: false
-  # gem 'scrap', require: false
-  # gem 'rails_best_practices', require: false
-  # gem 'rubocop', require: false
-  # gem 'rubycritic', require: false
-  # gem 'metric_fu', require: false
 
-  # security checkers
-  # gem 'codesake-dawn', require: false
-  # gem 'brakeman', require: false
-
-  # database checks
-  # gem 'lol_dba', require: false
-  # gem 'consistency_fail', require: false
+  # linting and formatting
+  gem 'rubocop', require: false
 
-  #gem 'debugger'
-  # gem install traceroute --no-ri --no-rdoc
+  # generating changelogs
+  gem 'github_changelog_generator'
 end
 
 group :test do

Gemfile.lock

@@ -182,9 +182,21 @@ GEM
       railties (>= 4.2.0)
     faker (2.12.0)
       i18n (>= 1.6, < 2)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
     ffi (1.13.1)
     font-awesome-sass (4.6.2)
       sass (>= 3.2)
+    github_changelog_generator (1.15.2)
+      activesupport
+      faraday-http-cache
+      multi_json
+      octokit (~> 4.6)
+      rainbow (>= 2.2.1)
+      rake (>= 10.0)
+      retriable (~> 3.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     haml (5.1.2)
@@ -270,6 +282,7 @@ GEM
     mono_logger (1.1.0)
     msgpack (1.3.3)
     multi_json (1.14.1)
+    multipart-post (2.1.1)
     mustache (1.1.1)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
@@ -280,6 +293,9 @@ GEM
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
+    octokit (4.18.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
     orm_adapter (0.5.0)
     paperclip (6.1.0)
       activemodel (>= 4.2.0)
@@ -362,6 +378,7 @@ GEM
       resque (>= 1.17, < 3)
     resque_solo (0.5.0)
       resque (>= 1.25.0)
+    retriable (3.1.2)
     reverse_markdown (2.0.0)
       nokogiri
     rexml (3.2.4)
@@ -436,6 +453,9 @@ GEM
       sprockets (> 3.0)
       sprockets-rails
       tilt
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
     sexp_processor (4.15.0)
     shellany (0.0.1)
     shoulda-matchers (4.3.0)
@@ -546,6 +566,7 @@ DEPENDENCIES
   factory_bot_rails
   faker
   font-awesome-sass (~> 4.6.2)
+  github_changelog_generator
   haml (~> 5.1.2)
   haml-rails (~> 2.0.1)
   i18n-inflector-rails (~> 1.0)