repo sync

Author: Octomerger

content/README.md

@@ -184,8 +184,10 @@ featuredLinks:
 
 ### `changelog`
 
-- Purpose: Render a list of changelog items with timestamps on product pages (ex: `layouts/product-landing.html`)
-- Type: `Array`, items are objects `{ href: string, title: string, date: 'YYYY-MM-DD' }`
+- Purpose: Render a list of items pulled from [GitHub Changelog](https://github.blog/changelog/) on product landing pages (ex: `layouts/product-landing.html`). The one exception is Education, which pulls from https://github.blog/category/community/education.
+- Type: `Object`, properties:
+  - `label` -- must be present and corresponds to the labels used in the [GitHub Changelog](https://github.blog/changelog/)
+  - `prefix` -- optional string that starts each changelog title that should be omitted in the docs feed. For example, with the prefix `GitHub Actions: ` specified, changelog titles like `GitHub Actions: Some Title Here` will render as `Some Title Here` in the docs feed).
 - Optional.
 
 ### `defaultPlatform`
@@ -223,7 +225,7 @@ includeGuides:
 ```
 
 ### `type`
-- Purpose: Indicate the type of article. 
+- Purpose: Indicate the type of article.
 - Type: `String`, one of the `overview`, `quick_start`, `tutorial`, `how_to`, `reference`.
 - Optional.
 

content/actions/index.md

@@ -22,18 +22,9 @@ featuredLinks:
     - /actions/reference/environment-variables
     - /actions/reference/encrypted-secrets
 changelog:
-  - title: Environments, environment protection rules and environment secrets (beta)
-    date: '2020-12-15'
-    href: https://github.blog/changelog/2020-12-15-github-actions-environments-environment-protection-rules-and-environment-secrets-beta/
-  - title: Workflow visualization
-    date: '2020-12-08'
-    href: https://github.blog/changelog/2020-12-08-github-actions-workflow-visualization/
-  - title: Removing set-env and add-path commands on November 16
-    date: '2020-11-09'
-    href: https://github.blog/changelog/2020-10-01-github-actions-deprecating-set-env-and-add-path-commands/
-
+  label: 'actions'
+  prefix: 'GitHub Actions: '
 product_video: https://www.youtube-nocookie.com/embed/cP0I9w2coGU
-
 redirect_from:
   - /articles/automating-your-workflow-with-github-actions/
   - /articles/customizing-your-project-with-github-actions/

content/discussions/index.md

@@ -22,6 +22,8 @@ featuredLinks:
     - /discussions/guides/finding-discussions-across-multiple-repositories
     - /discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions
     - /discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository
+changelog:
+  label: 'discussions'
 product_video: https://www.youtube-nocookie.com/embed/IpBw2SJkFyk
 layout: product-landing
 versions:

content/education/index.md

@@ -19,21 +19,8 @@ featuredLinks:
     - /desktop
     - /github/getting-started-with-github/github-cli
     - /education/manage-coursework-with-github-classroom/teach-with-github-classroom
-
 changelog:
-  - title: 'Try something new at Local Hack Day: Learn'
-    date: '2020-10-15'
-    href: https://github.blog/2020-10-15-try-something-new-at-local-hack-day-learn/
-  - title: 'Remote Education: Creating community through shared experiences'
-    date: '2020-09-24'
-    href: https://github.blog/2020-09-24-remote-education-creating-community-through-shared-experiences/
-  - title: 'Remote Education: A series of best practices for online campus communities'
-    date: '2020-09-10'
-    href: https://github.blog/2020-09-10-remote-education-a-series-of-best-practices-for-online-campus-communities/
-  - title: Welcome to the inaugural class of MLH Fellows
-    date: '2020-06-24'
-    href: https://github.blog/2020-06-24-welcome-to-the-inaugural-class-of-mlh-fellows/
-
+  label: 'education'
 layout: product-landing
 versions:
   free-pro-team: '*'

content/packages/index.md

@@ -20,15 +20,8 @@ featuredLinks:
     - /packages/guides/enabling-improved-container-support
     - /packages/guides/configuring-rubygems-for-use-with-github-packages
 changelog:
-  - title: ghcr.io maintenance mode on 2021-01-09
-    date: '2021-01-08'
-    href: https://github.blog/changelog/2021-01-08-packages-ghcr-io-maintenance-mode-on-2021-01-09/
-  - title: ghcr.io container names redirect to the container page
-    date: '2020-12-14'
-    href: https://github.blog/changelog/2020-12-14-ghcr-io-container-names-redirect-to-the-container-page/
-  - title: Filter for tagged and untagged containers
-    date: '2020-12-14'
-    href: https://github.blog/changelog/2020-12-14-packages-can-filter-for-tagged-and-untagged-containers/
+  label: 'packages'
+  prefix: 'Packages: '
 redirect_from:
   - /github/managing-packages-with-github-packages
   - /categories/managing-packages-with-github-package-registry

layouts/product-landing.html

@@ -98,12 +98,12 @@ <h2 class="link-with-intro-title f5">{{ link.title }}<span class="Bump-link-symb
             <div class="col-12 col-lg-4 mb-4 mb-lg-0">
               <div class="featured-links-heading mb-4 d-flex flex-items-baseline">
                 <h3 class="f4 text-normal text-mono text-uppercase color-gray-5">{% data ui.toc.whats_new %}</h3>
-                <a href="https://github.blog/changelog/" class="ml-4">View all {% octicon "arrow-right" height="14" class="v-align-middle" %}</a>
+                <a href="{{ changelogUrl }}" class="ml-4">View all {% octicon "arrow-right" height="14" class="v-align-middle" %}</a>
               </div>
               <ul class="list-style-none">
-                {% for link in page.changelog %}
+                {% for link in whatsNewChangelog %}
                   <li class="border-top">
-                    <a href="{{ link.href }}" class="d-block text-gray-dark Bump-link--hover py-3 no-underline">
+                    <a href="{{ link.href }}" class="d-block text-gray-dark Bump-link--hover py-3 no-underline capitalize">
                       <h4>{{ link.title }} <span class="Bump-link-symbol">→</span></h4>
                       <time
                         class="tooltipped tooltipped-n text-gray-light text-mono mt-1"

lib/changelog.js

@@ -0,0 +1,42 @@
+const Parser = require('rss-parser')
+
+async function getRssFeed (url) {
+  const parser = new Parser({ timeout: 5000 })
+  const feedUrl = `${url}/feed`
+  let feed
+
+  try {
+    feed = await parser.parseURL(feedUrl)
+  } catch (err) {
+    console.error(`cannot get ${feedUrl}: ${err.message}`)
+    return
+  }
+
+  return feed
+}
+
+async function getChangelogItems (prefix, feed) {
+  if (!feed || !feed.items) {
+    console.log(feed)
+    console.error('feed is not valid or has no items')
+    return
+  }
+
+  // only show the first 3 posts
+  const changelog = feed.items
+    .slice(0, 3)
+    .map(item => {
+      // remove the prefix if it exists (Ex: 'GitHub Actions: '), where the colon and expected whitespace should be hardcoded.
+      const title = prefix ? item.title.replace(new RegExp(`^${prefix}`), '') : item.title
+      return {
+        // capitalize the first letter of the title
+        title: title.trim().charAt(0).toUpperCase() + title.slice(1),
+        date: item.isoDate,
+        href: item.guid
+      }
+    })
+
+  return changelog
+}
+
+module.exports = { getRssFeed, getChangelogItems }

lib/frontmatter.js

@@ -80,14 +80,10 @@ const schema = {
     },
     // Shown in `product-landing.html` "What's new" section
     changelog: {
-      type: 'array',
-      items: {
-        type: 'object',
-        properties: {
-          title: { type: 'string' },
-          date: { type: 'string', format: 'date' },
-          href: { type: 'string' }
-        }
+      type: 'object',
+      properties: {
+        label: { type: 'string' },
+        prefix: { type: 'string' }
       }
     },
     type: {

middleware/contextualizers/whats-new-changelog.js

@@ -0,0 +1,13 @@
+const { getRssFeed, getChangelogItems } = require('../../lib/changelog')
+
+module.exports = async function whatsNewChangelog (req, res, next) {
+  if (!req.context.page) return next()
+  if (!req.context.page.changelog) return next()
+  req.context.changelogUrl = req.context.page.changelog.label === 'education'
+    ? 'https://github.blog/category/community/education'
+    : `https://github.blog/changelog/label/${req.context.page.changelog.label}`
+
+  const feed = await getRssFeed(req.context.changelogUrl)
+  req.context.whatsNewChangelog = await getChangelogItems(req.context.page.changelog.prefix, feed)
+  return next()
+}

middleware/index.js

@@ -109,6 +109,7 @@ module.exports = function (app) {
   app.use(instrument('./contextualizers/graphql'))
   app.use(instrument('./contextualizers/rest'))
   app.use(instrument('./contextualizers/webhooks'))
+  app.use(asyncMiddleware(instrument('./contextualizers/whats-new-changelog')))
   app.use(asyncMiddleware(instrument('./breadcrumbs')))
   app.use(asyncMiddleware(instrument('./early-access-breadcrumbs')))
   app.use(asyncMiddleware(instrument('./enterprise-server-releases')))