Skip to content

Commit 2b4aecc

Browse files
committed
chore(release): Upgrade version
1 parent fec813e commit 2b4aecc

File tree

7 files changed

+31
-9
lines changed

7 files changed

+31
-9
lines changed

.github/CONTRIBUTING.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,14 @@ $ docker compose build
4343
$ docker compose run action
4444
```
4545

46+
> [!CAUTION]
47+
> 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).
48+
4649
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
4750
[GitHub Actions Documentation](https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables).
4851
4952
> [!IMPORTANT]
50-
> The action will search for configuration file and dependencies in the `/github/workspace` directory. The root workspace directory is mounted as a volume in the container in that folder. You can set another directory to be checked by setting the `INPUT_CWD` environment variable to the desired directory (e.g. `INPUT_CWD=test-action`).
53+
> 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`).
5154
5255
### Test the Node.js code locally
5356

CHANGELOG.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1111
#### Deprecated
1212
#### Removed
1313

14+
## [2.0.0] - 2025-03-18
15+
16+
### Changed
17+
18+
* feat(BREAKING CHANGE): Throw an error in case the `cwd` input is absolute, because the action only has access to the repository files
19+
* chore: Use Docker action instead of Node.js action in order to install Chromium and Puppeteer
20+
* chore: Use Pnpm instead of NPM
21+
* 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.
22+
23+
### Fixed
24+
25+
* fix: Generate mermaid diagrams in the Confluence page
26+
27+
### Added
28+
29+
* docs: Add automation notice to Confluence pages containing the action docs
30+
* test: Add mermaid diagram to readme.md file, and test that it has been synced to Confluence in E2E tests
31+
32+
1433
## [1.2.0] - 2025-03-13
1534

1635
### Changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ docs/
6363

6464
```yaml
6565
- name: Sync markdown files to Confluence
66-
uses: Telefonica/markdown-confluence-sync-action@v1
66+
uses: Telefonica/markdown-confluence-sync-action@v2
6767
with:
6868
mode: tree
6969
docs-dir: './docs'
@@ -89,7 +89,7 @@ For example:
8989

9090
```yaml
9191
- name: Sync markdown files to Confluence
92-
uses: Telefonica/markdown-confluence-sync-action@v1
92+
uses: Telefonica/markdown-confluence-sync-action@v2
9393
with:
9494
mode: id
9595
docs-dir: '.'
@@ -132,7 +132,7 @@ confluence_page_id: 123456789
132132

133133
```yaml
134134
- name: Sync markdown files to Confluence
135-
uses: Telefonica/markdown-confluence-sync-action@v1
135+
uses: Telefonica/markdown-confluence-sync-action@v2
136136
with:
137137
mode: flat
138138
docs-dir: './docs'
@@ -187,7 +187,7 @@ The action accepts a configuration file in the root of the repository, and it ca
187187
| `confluence-notice-template` | Template string to use for the notice message | No | |
188188
| `confluence-dry-run` | Dry run mode: Do not update Confluence pages. Only log pages to sync | No | `false `|
189189
| `log-level` | Log level: `silent`, `silly`, `debug`, `verbose`, `info`, `warn`, `error` | No | `info` |
190-
| `cwd` | Current working directory. Path from where resolve `docs-dir`, `files-pattern`, and search for the configuration file | No | `.` |
190+
| `cwd` | Current working directory. Path from where resolve `docs-dir`, `files-pattern`, and search for the configuration file. It must be relative to the repository folder | No | `.` |
191191

192192
> [!NOTE]
193193
> Some markdown-confluence-sync options are not available as inputs in the action, as `preprocessor`. If you need to use them, you can set them in the [configuration file](#configuration-file) or using [environment variables](#environment-variables). Refer to the [Markdown Confluence Sync library docs](https://github.com/Telefonica/cross-confluence-tools/tree/main/components/markdown-confluence-sync#configuration-file) for further info about all available options.

dist/index.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/index.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "markdown-confluence-sync-action",
33
"description": "GitHub Action to sync markdown files to Confluence",
4-
"version": "1.2.0",
4+
"version": "2.0.0",
55
"author": "Telefónica Innovación Digital",
66
"homepage": "https://github.com/Telefonica/markdown-confluence-sync-action",
77
"repository": {

src/main.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ import { MarkdownConfluenceSync } from "@tid-xcut/markdown-confluence-sync";
66
import { parse } from "yaml";
77
import { join, isAbsolute } from "path";
88

9+
// NOTE: Change this value to a relative path to the repository root to test the node.js code locally, such as "test-action". Docs and configuration should be placed there.
910
const BASE_CWD = "/github/workspace";
10-
// const BASE_CWD = "test-action";
1111

1212
function valueIfDefined<T = string>(value: T | undefined): T | undefined {
1313
return value === "" ? undefined : value;

0 commit comments

Comments
 (0)