@edx/edx-bootstrap - npm Package Compare versions

Comparing version 2.6.0 to 2.6.1

.github/workflows/lockfileversion-check.yml

+#check package-lock file version
+
+name: Lockfile Version check
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+
+jobs:
+  version-check:
+    uses: openedx/.github/.github/workflows/lockfileversion-check-v3.yml@master

catalog-info.yaml

+# This file records information about this repo. Its use is described in OEP-55:
+# https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0055-proc-project-maintainers.html
+
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: 'edx-bootstrap'
+  description: "This library is an extension of Bootstrap 4, provides a set of tools to bootstrap a new Open edX project."
+spec:
+  type: 'library'
+  owner: group:openedx-unmaintained

.github/workflows/ci.yml

@@ -12,13 +12,11 @@ name: Node CI
 jobs:
-  build:
-    runs-on: ubuntu-20.04
+  tests:
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
-      - name: Setup Nodejs Env
-        run: echo "NODE_VER=`cat .nvmrc`" >> $GITHUB_ENV
+        uses: actions/checkout@v6
       - name: Setup Nodejs
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v6
         with:
-          node-version: ${{ env.NODE_VER }}
+          node-version-file: '.nvmrc'
 
@@ -25,0 +23,0 @@ - name: Install Dependencies

.github/workflows/npm-publish.yml

@@ -7,17 +7,19 @@
 
+permissions:
+  id-token: write  # Required for OIDC
+  contents: write  # For Semantic Release tagging
+
 jobs:
   release:
     name: Release
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v6
         with:
           fetch-depth: 0
-      - name: Setup Nodejs Env
-        run: echo "NODE_VER=`cat .nvmrc`" >> $GITHUB_ENV
       - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v6
         with:
-          node-version: ${{ env.NODE_VER }}
+          node-version-file: '.nvmrc'
 
@@ -32,4 +34,3 @@ - name: Install dependencies
         env:
-          GITHUB_TOKEN: ${{ secrets.SEMANTIC_RELEASE_GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.SEMANTIC_RELEASE_NPM_TOKEN }}
-        run: npm run semantic-release
+          GITHUB_TOKEN: ${{ secrets.OPENEDX_SEMANTIC_RELEASE_GITHUB_TOKEN }}
+        run: npx semantic-release@25

.nvmrc

@@ -1,1 +0,1 @@
-18
+24

package.json

@@ -5,4 +5,4 @@ {
   "license": "Apache-2.0",
-  "repository": "[e-mail]:edx/edx-bootstrap.git",
-  "version": "2.6.0",
+  "repository": "https://github.com/openedx/edx-bootstrap.git",
+  "version": "2.6.1",
   "homepage": "http://edx.github.io/edx-bootstrap",
@@ -37,8 +37,8 @@ "scripts": {
     "@fortawesome/free-solid-svg-icons": "5.15.4",
-    "@fortawesome/react-fontawesome": "0.2.0",
-    "chroma-js": "2.4.2",
-    "classnames": "2.3.2",
-    "gh-pages": "5.0.0",
-    "husky": "8.0.3",
-    "jquery": "3.7.0",
+    "@fortawesome/react-fontawesome": "0.2.6",
+    "chroma-js": "3.2.0",
+    "classnames": "2.5.1",
+    "gh-pages": "6.3.0",
+    "husky": "9.1.7",
+    "jquery": "3.7.1",
     "lodash": "4.17.21",
@@ -50,7 +50,8 @@ "node-sass": "9.0.0",
     "react-dom": "17.0.2",
-    "react-router-dom": "6.14.2",
-    "react-router-hash-link": "1.2.2",
-    "react-scripts": "5.0.1",
-    "semantic-release": "^20.1.3"
+    "react-router-dom": "6.30.3",
+    "react-router-hash-link": "2.4.3"
   },
+  "overrides": {
+    "node-gyp": "^10.0.1"
+  },
   "release": {
@@ -57,0 +58,0 @@ "branch": "master",

README.rst

@@ -0,9 +1,13 @@
+##############
+edX Bootstrap
+##############
+
 .. image:: https://badge.fury.io/js/%40edx%2Fedx-bootstrap.svg
     :target: https://badge.fury.io/js/%40edx%2Fedx-bootstrap
 .. highlight:: css
-    
-=============
-edX Bootstrap
-=============
 
+********
+Purpose
+********
+
 This library is an extension of `Bootstrap 4 <http://getbootstrap.com>`_
@@ -13,3 +17,3 @@ for use with edX and openEdX.
 Installation
-------------
+=============
 
@@ -20,4 +24,25 @@ Using npm::
 
+Cloning and Startup
+===================
+
+.. code-block::
+
+
+  1. Clone your new repo:
+
+    ``git clone https://github.com/openedx/edx-bootstrap.git``
+
+  2. Use node v18.x.
+
+    The current version of the micro-frontend build scripts support node 18.
+    Using other major versions of node *may* work, but this is unsupported.  For
+    convenience, this repository includes an .nvmrc file to help in setting the
+    correct node version via `nvm <https://github.com/nvm-sh/nvm>`_.
+
+  3. Install npm dependencies:
+
+    ``cd edx-bootstrap && npm ci``
+
 Usage
------
+=====
 
@@ -43,3 +68,3 @@ Add the following import in your project's base scss file::
 Theming
--------
+=======
 
@@ -72,3 +97,4 @@ The content of a `theme.scss` file::
 Getting Help
-------------
+============
+
 If you’re having trouble, you can ask in the front-end channel on Slack or contact the Frontend Working Group:
@@ -80,3 +106,3 @@
 License
--------
+=======
 
@@ -88,3 +114,3 @@ The code in this repository uses the Apache 2.0 license unless otherwise noted.
 Documentation
--------------
+=============
 
@@ -97,3 +123,3 @@ Documentation details can be found in the `docs index.rst`_.
 How to Contribute
------------------
+=================
 
@@ -108,8 +134,8 @@ Contributions are very welcome, but for legal reasons, you must submit a
 Reporting Security Issues
--------------------------
+=========================
 
 Please do not report security issues in public. Please email
[e-mail].
[e-mail].
 
 .. _individual contributor agreement: https://open.edx.org/wp-content/uploads/2019/01/individual-contributor-agreement.pdf
 .. _CONTRIBUTING: https://github.com/openedx/.github/blob/master/CONTRIBUTING.md

New alerts

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Fixed alerts

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1212601

0.09%

Dev dependency count

18

-10%

Number of package files

115

1.77%

Number of lines in readme file

134

24.07%

No dependency changes