Merge pull request #185 from openedx/jawayria/fix-release-ci

fix: Added semantic-release v17 in package.json to fix release CI

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @edx/community-engineering

.github/workflows/add-depr-ticket-to-depr-board.yml

@@ -0,0 +1,19 @@
+# Run the workflow that adds new tickets that are either:
+# - labelled "DEPR"
+# - title starts with "[DEPR]"
+# - body starts with "Proposal Date" (this is the first template field)
+# to the org-wide DEPR project board
+
+name: Add newly created DEPR issues to the DEPR project board
+
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  routeissue:
+    uses: openedx/.github/.github/workflows/add-depr-ticket-to-depr-board.yml@master
+    secrets:
+      GITHUB_APP_ID: ${{ secrets.GRAPHQL_AUTH_APP_ID }}
+      GITHUB_APP_PRIVATE_KEY: ${{ secrets.GRAPHQL_AUTH_APP_PEM }}
+      SLACK_BOT_TOKEN: ${{ secrets.SLACK_ISSUE_BOT_TOKEN }}

.github/workflows/ci.yml

@@ -1,17 +1,26 @@
 name: Default CI
-on: [push, pull_request]
+on: 
+  push:
+    branches:
+    - 'master'
+  pull_request:
+    branches:
+    - '**'
 jobs:
-  build:
+  tests:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: [12, 14, 16]
     steps:
     - name: Checkout
       uses: actions/checkout@v2
       with:
         fetch-depth: 0
     - name: Setup Nodejs
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v2
       with:
-        node-version: 12
+        node-version: ${{ matrix.node }}
     - name: Install dependencies
       run: npm ci
     - name: Validate package-lock.json changes
@@ -23,4 +32,4 @@ jobs:
     - name: i18n_extract
       run: npm run i18n_extract
     - name: Coverage
-      uses: codecov/codecov-action@v1
+      uses: codecov/codecov-action@v2

.github/workflows/commitlint.yml

@@ -0,0 +1,10 @@
+# Run commitlint on the commit messages in a pull request.
+
+name: Lint Commit Messages
+
+on:
+  - pull_request
+
+jobs:
+  commitlint:
+    uses: edx/.github/.github/workflows/commitlint.yml@master

.github/workflows/release.yml

@@ -13,7 +13,7 @@ jobs:
         with:
           fetch-depth: 0
       - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
           node-version: 12
       - name: Install dependencies
@@ -27,7 +27,7 @@ jobs:
       - name: i18n_extract
         run: npm run i18n_extract
       - name: Coverage
-        uses: codecov/codecov-action@v1
+        uses: codecov/codecov-action@v2
       - name: Build
         run: npm run build
       - name: Release

README.rst

@@ -1,61 +1,95 @@
+#########################
 frontend-component-footer
-=========================
+#########################
 
-|Build Status| |Coveralls| |npm_version| |npm_downloads| |license|
-|semantic-release|
+|Build Status| |Codecov| |npm_version| |npm_downloads| |license| |semantic-release|
 
-frontend-component-footer is a library containing a site footer
-component for use when building Open edX frontend applications.
-
-Usage
------
-
-To install frontend-component-footer into your project::
-
-   npm i --save @edx/frontend-component-footer
-
-Component Usage::
-
-   import Footer, { messages } from '@edx/frontend-component-footer';
-
-   ...
-
-   <Footer
-      onLanguageSelected={(languageCode) => {/* set language */}}
-      supportedLanguages={[
-         { label: 'English', value: 'en'},
-         { label: 'Español', value: 'es' },
-      ]}
-   />
-
-- onLanguageSelected (optional)
-- supportedLanguages (optional)
-
-Styles (project.scss)::
-
-   @import '@edx/frontend-component-footer/src/footer.scss';
+********
+Overview
+********
 
+A generic footer for Open edX micro-frontend applications.  It includes a logo and an optional language selector dropdown.
 
+************
 Requirements
-------------
+************
 
-This component uses ``@edx/frontend-i18n``. Any containing app must provide ``@edx/frontend-i18n`` as a peer dependency, and be wrapped inside an ``IntlProvider`` element, whether or not your consuming application is actually localized. For a basic default locale (English) version, follow the ``IntlProvider`` example in the sample application in `src/index.jsx <src/index.jsx>`__.
+This component uses ``@edx/frontend-platform`` services such as i18n, analytics, configuration, and the ``AppContext`` React component, and expects that it has been loaded into a micro-frontend that has been properly initialized via ``@edx/frontend-platform``'s ``initialize`` function.  `Please visit the frontend template application to see an example. <https://github.com/edx/frontend-template-application/blob/3355bb3a96232390e9056f35b06ffa8f105ed7ca/src/index.jsx>`_
 
+Environment Variables
+=====================
+
+This component requires that the following environment variable be set by the consuming micro-frontend.
+
+* ``LOGO_TRADEMARK_URL`` - This is a URL to a logo for use in the footer.  This is a different environment variable than ``LOGO_URL`` (used in frontend-component-header) to accommodate sites that would like to have additional trademark information on a logo in the footer, such as a (tm) or (r) symbol.
+
+************
+Installation
+************
+
+To install this footer into your Open edX micro-frontend, run the following command in your MFE:
+
+``npm i --save @edx/frontend-component-footer``
+
+This will make the component available to be imported into your application.
+
+*****
+Usage
+*****
+
+This library has the following exports:
+
+* ``(default)``: The footer as a React component.
+* ``messages``: Internationalization messages suitable for use with `@edx/frontend-platform/i18n <https://edx.github.io/frontend-platform/module-Internationalization.html>`_
+* ``dist/footer.scss``: A SASS file which contains style information for the component.  It should be imported into the micro-frontend's own SCSS file.
+
+<Footer /> component props
+==========================
+
+* onLanguageSelected: Provides the footer with an event handler for when the user selects a
+  language from its dropdown.
+* supportedLanguages: An array of objects representing available languages.  See example below for object shape.
+
+Examples
+========
+
+Component Usage Example::
+
+  import Footer, { messages } from '@edx/frontend-component-footer';
+
+  ...
+
+  <Footer
+    onLanguageSelected={(languageCode) => {/* set language */}}
+    supportedLanguages={[
+      { label: 'English', value: 'en'},
+      { label: 'Español', value: 'es' },
+    ]}
+  />
+
+* `An example of minimal component and messages usage. <https://github.com/edx/frontend-template-application/blob/3355bb3a96232390e9056f35b06ffa8f105ed7ca/src/index.jsx#L23>`_
+* `An example of SCSS file usage. <https://github.com/edx/frontend-template-application/blob/3cd5485bf387b8c479baf6b02bf59e3061dc3465/src/index.scss#L9>`_
+
+***********
 Development
------------
+***********
 
-Start the dev server::
+Install dependencies::
 
-   npm i && npm start
+  npm i
 
-Build the component::
+Start the development server::
 
-   npm run build
+  npm start
 
-.. |Build Status| image:: https://api.travis-ci.org/edx/frontend-component-footer.svg?branch=master
-   :target: https://travis-ci.org/edx/frontend-component-footer
-.. |Coveralls| image:: https://img.shields.io/coveralls/edx/frontend-component-footer.svg?branch=master
-   :target: https://coveralls.io/github/edx/frontend-component-footer
+Build a production distribution::
+
+  npm run build
+
+.. |Build Status| image:: https://api.travis-ci.com/edx/frontend-component-footer.svg?branch=master
+   :target: https://travis-ci.com/edx/frontend-component-footer
+.. |Codecov| image:: https://img.shields.io/codecov/c/github/edx/frontend-component-footer
+   :target: @edx/frontend-component-footer
 .. |npm_version| image:: https://img.shields.io/npm/v/@edx/frontend-component-footer.svg
    :target: @edx/frontend-component-footer
 .. |npm_downloads| image:: https://img.shields.io/npm/dt/@edx/frontend-component-footer.svg

commitlint.config.js

@@ -1,3 +0,0 @@
-module.exports = {
-  extends: ['@commitlint/config-angular'],
-};

package.json

@@ -19,8 +19,7 @@
   ],
   "husky": {
     "hooks": {
-      "pre-commit": "npm run lint",
-      "commit-msg": "commitlint -e $GIT_PARAMS"
+      "pre-commit": "npm run lint"
     }
   },
   "repository": {
@@ -34,37 +33,33 @@
   },
   "homepage": "https://github.com/edx/frontend-component-footer#readme",
   "devDependencies": {
-    "@commitlint/cli": "8.2.0",
-    "@commitlint/config-angular": "8.2.0",
-    "@commitlint/prompt": "8.2.0",
-    "@commitlint/prompt-cli": "8.2.0",
     "@edx/brand": "npm:@edx/brand-openedx@1.1.0",
-    "@edx/frontend-build": "5.4.0",
-    "@edx/frontend-platform": "1.8.0",
-    "@edx/paragon": "12.0.5",
-    "codecov": "3.7.2",
-    "enzyme": "3.10.0",
-    "enzyme-adapter-react-16": "1.14.0",
-    "husky": "3.0.9",
+    "@edx/frontend-build": "9.1.0",
+    "@edx/frontend-platform": "^1.14.1",
+    "@edx/paragon": "^16.0.0",
+    "codecov": "3.8.3",
+    "enzyme": "3.11.0",
+    "enzyme-adapter-react-16": "1.15.6",
+    "husky": "7.0.4",
     "prop-types": "15.7.2",
-    "react": "16.10.2",
-    "react-dom": "16.10.2",
-    "react-redux": "^7.1.1",
-    "react-router-dom": "^5.1.2",
-    "react-test-renderer": "16.10.2",
+    "react": "16.14.0",
+    "react-dom": "16.14.0",
+    "react-redux": "7.2.6",
+    "react-router-dom": "5.3.0",
+    "react-test-renderer": "16.14.0",
     "reactifex": "1.1.1",
-    "redux": "^4.0.4"
+    "redux": "4.1.2",
+    "semantic-release": "^17.0.0"
   },
   "dependencies": {
-    "@fortawesome/fontawesome-svg-core": "1.2.32",
-    "@fortawesome/free-brands-svg-icons": "5.8.2",
-    "@fortawesome/free-regular-svg-icons": "5.8.2",
-    "@fortawesome/free-solid-svg-icons": "5.8.2",
-    "@fortawesome/react-fontawesome": "0.1.13"
+    "@fortawesome/fontawesome-svg-core": "1.2.36",
+    "@fortawesome/free-brands-svg-icons": "5.15.4",
+    "@fortawesome/free-regular-svg-icons": "5.15.4",
+    "@fortawesome/free-solid-svg-icons": "5.15.4",
+    "@fortawesome/react-fontawesome": "0.1.16"
   },
   "peerDependencies": {
     "@edx/frontend-platform": "^1.8.0",
-    "@edx/paragon": "^7.0.0",
     "prop-types": "^15.5.10",
     "react": "^16.9.0",
     "react-dom": "^16.9.0"

renovate.json

@@ -1,9 +1,28 @@
 {
   "extends": [
-    "config:base"
+    "config:base",
+    "schedule:weekly",
+    ":automergeLinters",
+    ":automergeMinor",
+    ":automergeTesters",
+    ":enableVulnerabilityAlerts",
+    ":rebaseStalePrs",
+    ":semanticCommits",
+    ":updateNotScheduled"
   ],
-  "patch": {
-    "automerge": true
-  },
-  "rebaseStalePrs": true
+  "packageRules": [
+    {
+      "matchDepTypes": [
+        "devDependencies"
+      ],
+      "matchUpdateTypes": [
+        "lockFileMaintenance",
+        "minor",
+        "patch",
+        "pin"
+      ],
+      "automerge": true
+    }
+  ],
+  "timezone": "America/New_York"
 }

src/components/Footer.jsx

@@ -53,7 +53,6 @@ class SiteFooter extends React.Component {
     return (
       <footer
         role="contentinfo"
-        aria-label={intl.formatMessage(messages['footer.logo.ariaLabel'])}
         className="footer d-flex border-top py-3 px-4"
       >
         <div className="container-fluid d-flex">

src/components/__snapshots__/Footer.test.jsx.snap

@@ -2,7 +2,6 @@
 
 exports[`<Footer /> renders correctly renders with a language selector 1`] = `
 <footer
-  aria-label="edX Home"
   className="footer d-flex border-top py-3 px-4"
   role="contentinfo"
 >
@@ -75,7 +74,6 @@ exports[`<Footer /> renders correctly renders with a language selector 1`] = `
 
 exports[`<Footer /> renders correctly renders without a language selector 1`] = `
 <footer
-  aria-label="edX Home"
   className="footer d-flex border-top py-3 px-4"
   role="contentinfo"
 >
@@ -106,7 +104,6 @@ exports[`<Footer /> renders correctly renders without a language selector 1`] =
 
 exports[`<Footer /> renders correctly renders without a language selector in es 1`] = `
 <footer
-  aria-label="edX Home"
   className="footer d-flex border-top py-3 px-4"
   role="contentinfo"
 >