Merge pull request #1568 from segmentio/changelogs

changelogs init

Author: markzegarelli

.vscode/launch.json

@@ -0,0 +1,7 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": []
+}

Makefile

@@ -53,6 +53,10 @@ serve: package
 catalog: vendor/bundle
 	@node scripts/catalog.js
 
+.PHONY: changelog
+changelog: vendor/bundle
+	@node scripts/changelog.js
+
 .PHONY: sidenav
 sidenav: vendor/bundle
 	@node scripts/nav.js

package-lock.json

@@ -52,6 +52,7 @@
     "glightbox": "^3.0.6",
     "htm": "^3.0.4",
     "hyperlink": "^4.5.2",
+    "json-to-pretty-yaml": "^1.2.2",
     "preact": "^10.5.12",
     "search-insights": "^1.7.1",
     "tap-spot": "^1.1.1",

package.json

@@ -292,7 +292,7 @@ const updateSources = async () => {
   })
 
   // Create source catalog yaml file
-  const options = { noArrayIndent: true };
+  const options = { noArrayIndent: false };
   var todayDate = new Date().toISOString().slice(0,10);
   output = "# AUTOGENERATED FROM PLATFORM API. DO NOT EDIT\n"
   output += "# sources last updated " + todayDate + " \n";

scripts/catalog.js

@@ -0,0 +1,53 @@
+const axios = require('axios');
+const path = require('path');
+const fs = require('fs');
+const fm = require('front-matter');
+const yaml = require('js-yaml');
+
+API_URL = "https://api.github.com/repos/segmentio/"
+
+const getLog = async (url = "") => {
+  try {
+   const res = await axios.get(url, {
+      headers: {
+        'Content-Type': 'application/json',
+      }
+    });
+    return res.data
+  } catch (error) {
+    console.log(error)
+  }
+}
+let libraries = ["analytics-android","analytics-ios", "analytics-react-native", "analytics-node", "analytics-python", "analytics-php", "analytics-go", "analytics-java", "analytics.NET"]
+
+const replace_token = /.+\r\n(-{2,}\r\n)|.+\r\n(={2,}\r\n)/mg;
+const subst = ``
+
+const updateLog = async(library) => {
+
+  let releasesUpdated = []
+  let url = API_URL+library+'/releases'
+  const releases = await getLog(url)
+  releases.forEach(release => {
+    let note = release.body
+    cleaned_note = note.replace(replace_token,subst)
+    let updatedRelease = {
+      version: release.name,
+      url: release.html_url,
+      date: release.published_at,
+      notes: cleaned_note
+    }
+   releasesUpdated.push(updatedRelease) 
+  })
+  
+  const options = { noArrayIndent: true };
+  var todayDate = new Date().toISOString().slice(0,10);
+  output = "# AUTOGENERATED FROM GITHUB API. DO NOT EDIT\n"
+  output += "# Releases last updated " + todayDate + " \n";
+  output += yaml.safeDump({ releases: releasesUpdated }, options);
+  fs.writeFileSync(path.resolve(__dirname, `../src/_data/changelogs/${library}.yml`), output);
+}
+
+libraries.forEach(library => {
+  updateLog(library);
+});

scripts/changelog.js

@@ -0,0 +1,75 @@
+# AUTOGENERATED FROM GITHUB API. DO NOT EDIT
+# Releases last updated 2021-05-07 
+releases:
+- version: 4.9.4
+  url: 'https://github.com/segmentio/analytics-android/releases/tag/4.9.4'
+  date: '2021-05-04T00:16:56Z'
+  notes: "* [Fix](https://github.com/segmentio/analytics-android/pull/761): Map product_id for a Product\r\n* [Fix](https://github.com/segmentio/analytics-android/pull/767): Safely handle bad URIs when tracking deep links"
+- version: 4.9.3
+  url: 'https://github.com/segmentio/analytics-android/releases/tag/4.9.3'
+  date: '2021-03-30T00:39:13Z'
+  notes: "* [Fix](https://github.com/segmentio/analytics-android/pull/755): Check Float NaN and Infinity\r\n* [Fix](https://github.com/segmentio/analytics-android/pull/758): Fix Incorrect Timestamps"
+- version: 4.9.2
+  url: 'https://github.com/segmentio/analytics-android/releases/tag/4.9.2'
+  date: '2021-03-22T19:13:24Z'
+  notes: "* [New](https://github.com/segmentio/analytics-android/pull/734): Make new lifecycle methods opt-out\r\n* [New](https://github.com/segmentio/analytics-android/pull/731): Kotlin Demo App\r\n* [New](https://github.com/segmentio/analytics-android/pull/739): Custom apiHost for Segment.IO and support multi-regional Segment\r\n* [Fix](https://github.com/segmentio/analytics-android/pull/750): Add NonNull annotations to params for analytics constructor\r\n* [Fix](https://github.com/segmentio/analytics-android/pull/749): Retry hasPermission in case of failure due to package manager being inactive\r\n* [Fix](https://github.com/segmentio/analytics-android/pull/752): Marshal NaN and other special numbers to 0.0 and not produce malformed JSON"
+- version: 4.9.0
+  url: 'https://github.com/segmentio/analytics-android/releases/tag/4.9.0'
+  date: '2020-10-16T00:33:56Z'
+  notes: "* [New](https://github.com/segmentio/analytics-android/pull/707): Remove the ability to natively report attribution information via Segment integrations\r\n* [New](https://github.com/segmentio/analytics-android/pull/727): Edge Function Support\r\n* [New](https://github.com/segmentio/analytics-android/pull/715): Add a Webhook Integration for viewing payloads\r\n* [New](https://github.com/segmentio/analytics-android/pull/728): Enable faster project settings refresh when debugging enabled"
+- version: 4.8.2
+  url: 'https://github.com/segmentio/analytics-android/releases/tag/4.8.2'
+  date: '2020-07-30T20:07:08Z'
+  notes: >-
+    * [Fix](https://github.com/segmentio/analytics-android/pull/686): Generate
+    timestamps at call site rather than asynchronously
+- version: 4.8.0
+  url: 'https://github.com/segmentio/analytics-android/releases/tag/4.8.0'
+  date: '2020-07-13T18:14:35Z'
+  notes: "\r\n* [Fix](https://github.com/segmentio/analytics-android/pull/668): Fix: Proguard/R8 configuration for createValueMap\r\n* [Fix](https://github.com/segmentio/analytics-android/pull/670): handle RuntimeException when calling `getActivityInfo`\r\n* [New](https://github.com/segmentio/analytics-android/pull/671): Experimental Nanosecond timestamps"
+- version: 4.7.1
+  url: 'https://github.com/segmentio/analytics-android/releases/tag/4.7.1'
+  date: '2020-06-08T23:32:57Z'
+  notes: "\r\n* [Fix](https://github.com/segmentio/analytics-android/pull/667): Use AndroidX lifecycle functions for App Fore/Backgrounded\r\n* [Fix](https://github.com/segmentio/analytics-android/pull/666): Fix alias not overridden by cached value\r\n* [Fix](https://github.com/segmentio/analytics-android/pull/663): Catch null intent data"
+- version: 4.7.0
+  url: 'https://github.com/segmentio/analytics-android/releases/tag/4.7.0'
+  date: '2020-06-01T22:03:42Z'
+  notes: "\r\n* [New](https://github.com/segmentio/analytics-android/pull/655): Add type to device context\r\n* [Fix](https://github.com/segmentio/analytics-android/pull/665): Prevent Global Context modification for one-time op\r\n* [New](https://github.com/segmentio/analytics-android/pull/664): Add support for Destination Middleware\r\n"
+- version: 4.6.0
+  url: 'https://github.com/segmentio/analytics-android/releases/tag/4.6.0'
+  date: '2020-05-21T18:17:59Z'
+  notes: "* [New](https://github.com/segmentio/analytics-android/pull/662): Add DefaultProjectSettings in Analytics.Builder\r\n* [Fix](https://github.com/segmentio/analytics-android/pull/659): Test coverage fix after previous merge to master\r\n* [New](https://github.com/segmentio/analytics-android/pull/658): Update project to AndroidX\r\n* [Fix](https://github.com/segmentio/analytics-android/pull/656): Set build property to String"
+- version: 4.5.0
+  url: 'https://github.com/segmentio/analytics-android/releases/tag/4.5.0'
+  date: '2020-04-22T19:59:57Z'
+  notes: "* Promoting 4.5.x to stable release.  This includes all changes since 4.3.1.\r\n* [Fix](https://github.com/fubotv/segment-analytics-android/pull/1): Check integration settings for null\r\n"
+- version: 4.5.0-beta.2
+  url: 'https://github.com/segmentio/analytics-android/releases/tag/4.5.0-beta.2'
+  date: '2020-03-23T17:55:25Z'
+  notes: " * [New](https://github.com/segmentio/analytics-android/pull/632): Make crypto abstract methods public\r\n * [Fix](https://github.com/segmentio/analytics-android/pull/648): Preserve BUILD and VERSION keys on reset() calls\r\n * [Fix](https://github.com/segmentio/analytics-android/pull/646): Resolves ArrayIndexOutOfBoundsException crash (#586)\r\n * [Fix](https://github.com/segmentio/analytics-android/pull/644): Updated documentation on deep copy and threading\r\n * [Fix](https://github.com/segmentio/analytics-android/pull/642): Double check that input stream is closed\r\n"
+- version: 4.5.0-beta.0
+  url: 'https://github.com/segmentio/analytics-android/releases/tag/4.5.0-beta.0'
+  date: '2019-07-26T23:30:17Z'
+  notes: >-
+    * [New](https://github.com/segmentio/analytics-android/pull/620): Add
+    Application Open and Application Backgrounded Events
+- version: ''
+  url: 'https://github.com/segmentio/analytics-android/releases/tag/4.3.0'
+  date: '2017-10-04T06:58:23Z'
+  notes: "Promoting RC to stable release. This includes all the improvements from 4.3.0-RC1 and 4.3.0-RC2.\r\n"
+- version: ''
+  url: 'https://github.com/segmentio/analytics-android/releases/tag/4.3.0-RC2'
+  date: '2017-07-28T03:53:05Z'
+  notes: " * [New](https://github.com/segmentio/analytics-android/pull/536): Look up Advertising ID for Amazon Fire devices.\r\n * [Fix](https://github.com/segmentio/analytics-android/pull/534): Attribution tracking using mobile service should be false by default.\r\n"
+- version: ''
+  url: 'https://github.com/segmentio/analytics-android/releases/tag/4.2.5'
+  date: '2017-05-26T16:13:11Z'
+  notes: " * [Fix](https://github.com/segmentio/analytics-android/pull/487/commits/8649050b4b7b74be17fc7b7e4ec0add7362325fd): Using `Properties#putProducts` was stored as an array instead of a list, and not serialized correctly. This caused it to be unusable by Segment and server side integrations. If you're stuck on a previous version for some reason, you can manually store it as a list:\r\n\r\n ```java\r\n List<Product> products = new ArrayList<>();\r\n products.add(new Product(\"foo\", \"bar\", 10));\r\n // add other products to this list.\r\n\r\n Properties properties = new Properties();\r\n properties.put(\"products\", products);\r\n ```"
+- version: ''
+  url: 'https://github.com/segmentio/analytics-android/releases/tag/4.2.6'
+  date: '2017-05-26T16:13:00Z'
+  notes: " * [Fix](https://github.com/segmentio/analytics-android/pull/495): Update Cartographer. This fixes an issue where sending custom values sent as arrays would not be serialized correctly.\r\n * [Fix](https://github.com/segmentio/analytics-android/pull/494): Make DateFormat access thread safe. This fixes an issue where generated timestamps could be sometimes be malformed and not conform to the ISO 8601 standard.\r\n"
+- version: ''
+  url: 'https://github.com/segmentio/analytics-android/releases/tag/4.3.0-RC1'
+  date: '2017-05-26T16:12:27Z'
+  notes: " * [New](https://github.com/segmentio/analytics-android/pull/515): Add Middlewares.\r\n * [Fix](https://github.com/segmentio/analytics-android/pull/524): Unregister Application lifecycle callbacks on shutdown.\r\n * [Fix](https://github.com/segmentio/analytics-android/pull/499): Record `ms` precision in timestamps.\r\n * [Fix](https://github.com/segmentio/analytics-android/pull/508): Support serialization of Primitive arrays.\r\n"

src/_data/changelogs/analytics-android.yml

@@ -0,0 +1,25 @@
+# AUTOGENERATED FROM GITHUB API. DO NOT EDIT
+# Releases last updated 2021-05-07 
+releases:
+- version: Fix vendor packages
+  url: 'https://github.com/segmentio/analytics-go/releases/tag/v3.0.1'
+  date: '2018-10-02T19:08:56Z'
+  notes: >-
+    analytics-go was failing to install correctly using vendored packages due to
+    its use of git submodules. We've replaced the git submodules with proper
+    Golang vendoring to fix this issue. In addition, we've updated some internal
+    tooling for the library itself, namely our circle builds and adding a test
+    CLI.
+- version: v3.0.0
+  url: 'https://github.com/segmentio/analytics-go/releases/tag/v3.0.0'
+  date: '2018-08-28T22:16:11Z'
+  notes: "v3 is a rewrite of our v2 version of the Go Library. We recommend using v3 as it supports many new features, has significant design improvements and is better tested.\r\n\r\nDocumentation on migrating from v2 to v3 is available at https://segment.com/docs/sources/server/go/#migrating-from-v2.\r\n\r\nThis release is the same as https://github.com/segmentio/analytics-go/releases/tag/3.0.0, but has the `v` prefix to work with [Go modules](https://github.com/golang/go/wiki/Modules). See https://github.com/segmentio/analytics-go/issues/134."
+- version: 3.0.0
+  url: 'https://github.com/segmentio/analytics-go/releases/tag/3.0.0'
+  date: '2018-01-05T23:44:33Z'
+  notes: "v3 is a rewrite of our v2 version of the Go Library. We recommend using v3 as it supports many new features, has significant design improvements and is better tested.\r\n\r\nDocumentation on migrating from v2 to v3 is available at https://segment.com/docs/sources/server/go/#migrating-from-v2."
+- version: ''
+  url: 'https://github.com/segmentio/analytics-go/releases/tag/2.1.1'
+  date: '2016-04-26T20:06:47Z'
+  notes: |
+    Version 2.1.1