Merge pull request #31 from Telefonica/release

Release v2.0.1

Author: javierbrea

.dockerignore

@@ -0,0 +1,5 @@
+*
+!package.json
+!pnpm-lock.yaml
+!bin/
+!dist/

.env.example

@@ -5,6 +5,13 @@
 # may be useful to set it to `true`.
 ACTIONS_STEP_DEBUG=true
 
+# E2E tests
+
+CONFLUENCE_URL=foo-confluence.atlassian.net
+CONFLUENCE_PAT=foo-access-token
+CONFLUENCE_README_PAGE_ID=foo-readme-page-id
+CONFLUENCE_CHANGELOG_PAGE_ID=foo-changelog-page-id
+
 # GitHub Actions inputs should follow `INPUT_<name>` format (case-sensitive).
 # Hyphens should not be converted to underscores!
 INPUT_DOCS-DIR="./docs"

.github/CONTRIBUTING.md

@@ -22,54 +22,48 @@ Thank you for being part of the Telefónica Innovación Digital Open Source Comm
 1. :hammer_and_wrench: Install the dependencies
 
    ```bash
-   npm install
+   pnpm install
    ```
 
-1. :building_construction: Package the TypeScript for distribution
+2. :white_check_mark: Run the unit tests
 
    ```bash
-   npm run package
-   ```
-
-1. :white_check_mark: Run the unit tests
-
-   ```bash
-   $ npm run test:unit
+   $ pnpm test:unit
 
    PASS  test/unit/specs/main.spec.ts
    PASS  test/unit/specs/index.spec.ts
    ...
 
 ## Test the action locally
 
-The [`@github/local-action`](https://github.com/github/local-action) utility
-can be used to test your action locally. It is a simple command-line tool
-that "stubs" (or simulates) the GitHub Actions Toolkit. This way, you can run
-your TypeScript action locally without having to commit and push your changes
-to a repository.
+The action is a Docker container that runs a Node.js script. To test the action locally, you can run the Docker compose file in the root of the repository. This will build the Docker image and run the action in a container.
 
-The `local-action` utility can be run in the following ways:
+```bash
+$ docker compose build
+$ docker compose run action
+```
 
-- Visual Studio Code Debugger
+> [!CAUTION]
+> The Docker image won't work in some systems due to the usage of Chromium, as in MacOS with M1 processors. In this case, you can [run the Node.js code instead](#test-the-nodejs-code-locally).
 
-   Make sure to review and, if needed, update
-   [`.vscode/launch.json`](./.vscode/launch.json)
+You can provide a `.env` file to set environment variables used by the GitHub Actions Toolkit. For more information, see the example file, [`.env.example`](./.env.example), and the
+[GitHub Actions Documentation](https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables).
 
-- Terminal/Command Prompt
+> [!IMPORTANT]
+> The root workspace directory is mounted as a volume in the container in the `/github/workspace` folder. You can set another workspace subdirectory for testing the synchronization locally by setting the `INPUT_CWD` environment variable to the desired directory (e.g. `INPUT_CWD=test-action`).
 
-   ```bash
-   # npx local action <action-yaml-path> <entrypoint> <dotenv-file>
-   npx local-action . src/main.ts .env
-   ```
+### Test the Node.js code locally
 
-You can provide a `.env` file to the `local-action` CLI to set environment
-variables used by the GitHub Actions Toolkit. For more information, see the example
-file, [`.env.example`](./.env.example), and the
-[GitHub Actions Documentation](https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables).
+Apart from running the unit tests, you can also run the Node.js code locally by following these steps:
+
+* Modify the `src/action/main.ts` file to change the `BASE_CWD` variable from `/github/workspace` to the desired directory (e.g. `test-action`).
+* Build the action code using the `pnpm build` command.
+* Add your markdown file and configuration files to the desired directory (e.g. `test-action/markdown-confluence-sync.config.js` and `test-action/docs/foo.md`).
+* Run the action code using `node bin/markdown-confluence-sync-action.js`.
 
 ## E2E tests
 
-This project includes end-to-end tests, consisting in a workflow that uses the action to sync the documentation of the project itself to a Confluence page, and then checks if the page was updated correctly.
+This project includes end-to-end tests, consisting in a workflow that uses the action to sync the documentation of the project itself to a Confluence page, and then checks if the page was updated correctly. Once the documentation has been synced, you can run tests using the following command:
 
 ```bash
 npm run test:e2e
@@ -111,32 +105,40 @@ But we use the __merge commit strategy for merging PRs to the main branch from t
 
 # Release process
 
-Once the PR is approved and merged into the main branch, a project maintainer can start the release process by tagging the main branch with the corresponding version numbers.
-
-This project includes a helper script, [`script/release`](./script/release)
-designed to streamline the process of tagging and pushing new releases for
-GitHub Actions.
-
-GitHub Actions allows users to select a specific version of the action to use,
-based on release tags. This script simplifies this process by performing the
-following steps:
-
-1. **Retrieving the latest release tag:** The script starts by fetching the most
-   recent SemVer release tag of the current branch, by looking at the local data
-   available in your repository.
-1. **Prompting for a new release tag:** The user is then prompted to enter a new
-   release tag. To assist with this, the script displays the tag retrieved in
-   the previous step, and validates the format of the inputted tag (vX.X.X). The
-   user is also reminded to update the version field in package.json.
-1. **Tagging the new release:** The script then tags a new release and syncs the
-   separate major tag (e.g. v1, v2) with the new release tag (e.g. v1.0.0,
-   v2.1.2). When the user is creating a new major release, the script
-   auto-detects this and creates a `releases/v#` branch for the previous major
-   version.
-1. **Pushing changes to remote:** Finally, the script pushes the necessary
-   commits, tags and branches to the remote repository. From here, you will need
-   to create a new release in GitHub so users can easily reference the new tags
-   in their workflows.
+Once the PR is approved and __merged into the release branch__, a project maintainer can start the release process by:
+
+1. Checking the version number in the `package.json` file and updating it if necessary.
+2. Checking the action version in the `.github/actions/check-and-comment/action.yml` file and updating it if necessary.
+3. Updating the CHANGELOG.md file with the changes in the new version.
+4. Remove the beta tags created for the PR check.
+5. Tagging the release branch with the corresponding version numbers.
+
+   This project includes a helper script, [`script/release`](./script/release)
+   designed to streamline the process of tagging and pushing new releases for
+   GitHub Actions.
+
+   GitHub Actions allows users to select a specific version of the action to use,
+   based on release tags. This script simplifies this process by performing the
+   following steps:
+
+   1. **Retrieving the latest release tag:** The script starts by fetching the most
+      recent SemVer release tag of the current branch, by looking at the local data
+      available in your repository.
+   2. **Prompting for a new release tag:** The user is then prompted to enter a new
+      release tag. To assist with this, the script displays the tag retrieved in
+      the previous step, and validates the format of the inputted tag (vX.X.X). The
+      user is also reminded to update the version field in package.json.
+   3. **Tagging the new release:** The script then tags a new release and syncs the
+      separate major tag (e.g. v1, v2) with the new release tag (e.g. v1.0.0,
+      v2.1.2). When the user is creating a new major release, the script
+      auto-detects this and creates a `releases/v#` branch for the previous major
+      version.
+   4. **Pushing changes to remote:** Finally, the script pushes the necessary
+      commits, tags and branches to the remote repository. From here, you will need
+      to create a new release in GitHub so users can easily reference the new tags
+      in their workflows.
+6. Create a new release in GitHub with the tag created in the previous step and the changes in the CHANGELOG.md file.
+7. Merge the release branch into the main branch.
 
 # License
 

.github/actions/setup-node/action.yml

@@ -12,20 +12,20 @@ inputs:
 runs:
   using: composite
   steps:
-    - name: Setup Node.js
-      id: setup-node
+    - name: Install pnpm
+      uses: pnpm/action-setup@v4
+    - name: Install Node.js
       uses: actions/setup-node@v4
       with:
         node-version-file: .node-version
-        cache: npm
+        cache: pnpm
     - uses: DamianReeves/[email protected]
       with:
         path: .npmrc
         contents: |
             @tid-xcut:registry=https://nexus.tid.es/repository/npm-xcut-components/
             //nexus.tid.es/repository/npm-xcut-components/:_auth=${{ inputs.npm-token }}
         write-mode: append
-    - name: Install Dependencies
+    - name: Install Node.js dependencies
       shell: bash
-      id: npm-ci
-      run: npm ci
+      run: pnpm install

.github/workflows/build.yml

@@ -28,32 +28,25 @@ jobs:
         with:
           npm-token: ${{ secrets.NPM_TOKEN_XCUT }}
 
+      - name: Build
+        id: build
+        run: pnpm build
+
       - name: Lint
         id: npm-lint
-        run: npm run lint
+        run: pnpm lint
 
       - name: Check spelling
         id: npm-check-spelling
-        run: npm run cspell
+        run: pnpm cspell
 
       - name: Check TypeScript types
         id: npm-check-types
-        run: npm run check:types
+        run: pnpm check:types
 
       - name: Test unit
         id: npm-test
-        run: npm run test:unit
-
-      - name: Upload coverage
-        id: upload-coverage
-        uses: actions/upload-artifact@v4
-        with:
-          name: coverage
-          path: coverage/
-
-      - name: Build dist/ Directory
-        id: build
-        run: npm run package
+        run: pnpm test:unit
 
       # This will fail the workflow if the `dist/` directory is different than
       # expected.
@@ -80,3 +73,10 @@ jobs:
         with:
           name: dist
           path: dist/
+
+      - name: Upload coverage
+        id: upload-coverage
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage
+          path: coverage/

.github/workflows/test-e2e.yml

@@ -28,6 +28,7 @@ jobs:
         with:
           mode: id
           docs-dir: '.'
+          confluence-notice-message: 'This page is automatically generated from content in the <a href="https://github.com/Telefonica/markdown-confluence-sync-action" target="_blank">markdown-confluence-sync-action repository</a> Changes made manually will be lost, you should edit this page in Github instead.'
           files-pattern: '*.md'
           files-metadata: |
             [
@@ -45,6 +46,7 @@ jobs:
           confluence-url: ${{ vars.CONFLUENCE_URL }}
           confluence-space-key: ${{ vars.CONFLUENCE_SPACE_KEY }}
           confluence-personal-access-token: ${{ secrets.CONFLUENCE_PAT }}
+          log-level: debug
 
   test-e2e:
     environment: production

.gitignore

@@ -2,6 +2,9 @@
 node_modules
 .npmrc
 
+# Test action locally
+test-action
+
 # Rest pulled from https://github.com/github/gitignore/blob/master/Node.gitignore
 # Logs
 logs

CHANGELOG.md

@@ -11,6 +11,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 #### Deprecated
 #### Removed
 
+## [2.0.1] - 2025-03-18
+
+### Changed
+
+* chore(deps): Bump @tid-xcut/markdown-confluence-sync from 1.1.0 to 1.1.1 (Fix preprocess hook)
+* docs: Improve release process guide in CONTRIBUTING.md
+
+## [2.0.0] - 2025-03-18
+
+### Changed
+
+* feat(BREAKING CHANGE): Throw an error in case the `cwd` input is absolute, because the action only has access to the repository files
+* chore: Use Docker action instead of Node.js action in order to install Chromium and Puppeteer
+* chore: Use Pnpm instead of NPM
+* chore: Move `dependencies` to `devDependencies`, because in runtime the action uses only the bundled code, and it installs the mermaid dependencies by itself in the Docker image. This is because the `@tid-xcut` libraries are in a private repository, and the action cannot install them in the Docker image. Some fixes are applied to the bundled code to make it work in the Docker image.
+
+### Fixed
+
+* fix: Generate mermaid diagrams in the Confluence page
+
+### Added
+
+* docs: Add automation notice to Confluence pages containing the action docs
+* test: Add mermaid diagram to readme.md file, and test that it has been synced to Confluence in E2E tests
+
+
 ## [1.2.0] - 2025-03-13
 
 ### Changed

Dockerfile

@@ -0,0 +1,32 @@
+FROM --platform=linux/amd64 node:22
+RUN corepack enable && corepack prepare [email protected] --activate
+
+# We don't need the standalone Chromium
+ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true
+ENV PUPPETEER_EXECUTABLE_PATH="/usr/bin/chromium"
+
+# cspell: disable
+# Install Google Chrome Stable and fonts
+# Note: this installs the necessary libs to make the browser work with Puppeteer, and the fonts needed for Mermaid
+RUN apt-get update && apt-get install curl gnupg -y \
+  && curl --location --silent https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add - \
+  && sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list' \
+  && apt-get update \
+  && apt-get install google-chrome-stable -y --no-install-recommends \
+  && apt-get install chromium -y \
+  && apt-get install -y \
+    fonts-noto-cjk fonts-noto-color-emoji \
+    fonts-terminus fonts-dejavu fonts-freefont-ttf \
+    fonts-font-awesome fonts-inconsolata \
+    fonts-linuxlibertine \
+  && fc-cache -f \
+  && rm -rf /var/lib/apt/lists/*
+
+# NOTE: We need to install Mermaid globally, as we are not installing the package.json dependencies due to private packages
+RUN npm i -g [email protected] @mermaid-js/[email protected]
+
+WORKDIR /usr/src/app
+
+COPY . .
+
+ENTRYPOINT [ "node", "/usr/src/app/bin/markdown-confluence-sync-action.js"]