Merge pull request #82 from feedzai/develop

Pre-release 3.1.1

Author: DiogoRDuarte

.github/workflows/release_package.yml

@@ -14,17 +14,22 @@ on:
 jobs:
   release:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
     steps:
       # Checkout project repository
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          persist-credentials: false
 
       # Setup Node.js environment
       - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
         with:
           registry-url: https://registry.npmjs.org/
           node-version: "18"
+          package-manager-cache: false
 
       # Install dependencies (required by Run tests step)
       - name: Install dependencies
@@ -76,14 +81,17 @@ jobs:
         run: |
           git add "package.json"
           git add "CHANGELOG.md"
-          git commit -m "chore: release ${{ env.NEW_VERSION }}"
-          git tag ${{ env.NEW_VERSION }}
+          git commit -m "chore: release ${NEW_VERSION}"
+          git tag "${NEW_VERSION}"
+        env:
+          NEW_VERSION: ${{ env.NEW_VERSION }}
 
       # Publish version to public repository
       - name: Publish
-        run: npm publish --verbose --access public --tag ${{ env.RELEASE_TAG }}
+        run: npm publish --verbose --access public --tag "${RELEASE_TAG}"
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPMJS_ACCESS_TOKEN }}
+          RELEASE_TAG: ${{ env.RELEASE_TAG }}
 
       # Push repository changes
       - name: Push changes to repository

.github/workflows/tests.yml

@@ -6,6 +6,8 @@ jobs:
   quality:
     name: E2E tests
     runs-on: ${{ matrix.os }}
+    permissions:
+      contents: read
     strategy:
       matrix:
         node-version:
@@ -14,11 +16,13 @@ jobs:
         os:
           - ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          persist-credentials: false
       - name: Using node ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
         with:
           node-version: ${{ matrix.node-version }}
-          cache: npm
+          package-manager-cache: false
       - run: npm ci
       - run: npm run test:ci

CHANGELOG.md

@@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
+### Added
+- Added 'CITATION.cff'
+- Updated CI/CD
+- Updated Readme
 
 ## 3.1.0 - 2026-02-10
 ### Added

CITATION.cff

@@ -0,0 +1,25 @@
+cff-version: 1.2.0
+title: feedzai-autovizua11y
+message: If you use autovizua11y, please cite it using the metadata from this file.
+type: software
+authors:
+  - name: Feedzai
+    email: oss-licenses@feedzai.com
+repository-code: https://github.com/feedzai/AutoVizuA11y
+url: https://feedzai.github.io/AutoVizuA11y/
+repository-artifact: https://www.npmjs.com/package/@feedzai/autovizua11y
+abstract: React library that automates the process of creating accessible data visualizations for screen reader users.
+keywords:
+  - react
+  - visualization
+  - javascript
+  - automation
+  - typescript
+  - accessibility
+  - screen-reader
+  - a11y
+  - data-visualization
+  - language-model
+  - genai
+license-url: https://github.com/feedzai/AutoVizuA11y/blob/main/LICENSE
+date-released: 2023-09-22

README.md

@@ -46,6 +46,22 @@ cd autovizua11y
   - Shortcuts that offer statistical insights about the data on demand;
   - A Shortcut Guide that can be consulted while focusing an AutoVizuA11y chart.
 
+### GitHub Actions
+
+AutoVizuA11y is published via [GitHub Actions](https://docs.github.com/en/actions). With that, [zizmor](https://github.com/zizmorcore/zizmor) is used to lint workflows and [pinact](https://github.com/suzuki-shunsuke/pinact) to pin versions of actions like `actions/checkout`.
+
+If you change the [`release_package.yml` or `tests.yml` file](.github/workflows/release.yml), install [zizmor](https://docs.zizmor.sh/installation/) (if necessary), run the following command, and implement the relevant feedback:
+
+```bash
+zizmor .
+```
+
+To update action versions, install [pinact](https://github.com/suzuki-shunsuke/pinact/blob/main/INSTALL.md) (if necessary) and run the following command:
+
+```bash
+pinact run -u --min-age 7
+```
+
 ## AutoVizuA11y component properties
 
 | Property                                       | Required/Optional   | Type             | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |