Skip to content

Commit 920d20e

Browse files
authored
Merge pull request #33 from Telefonica/release
Release v2.1.0
2 parents 5c3f453 + 0091831 commit 920d20e

File tree

11 files changed

+4846
-86
lines changed

11 files changed

+4846
-86
lines changed

.github/CONTRIBUTING.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,8 @@ But we use the __merge commit strategy for merging PRs to the main branch from t
108108
Once the PR is approved and __merged into the release branch__, a project maintainer can start the release process by:
109109
110110
1. Checking the version number in the `package.json` file and updating it if necessary.
111-
2. Checking the action version in the `.github/actions/check-and-comment/action.yml` file and updating it if necessary.
112-
3. Updating the CHANGELOG.md file with the changes in the new version.
113-
4. Remove the beta tags created for the PR check.
114-
5. Tagging the release branch with the corresponding version numbers.
111+
2. Updating the CHANGELOG.md file with the changes in the new version.
112+
3. Tagging the release branch with the corresponding version numbers.
115113
116114
This project includes a helper script, [`script/release`](./script/release)
117115
designed to streamline the process of tagging and pushing new releases for
@@ -137,8 +135,8 @@ Once the PR is approved and __merged into the release branch__, a project mainta
137135
commits, tags and branches to the remote repository. From here, you will need
138136
to create a new release in GitHub so users can easily reference the new tags
139137
in their workflows.
140-
6. Create a new release in GitHub with the tag created in the previous step and the changes in the CHANGELOG.md file.
141-
7. Merge the release branch into the main branch.
138+
4. Create a new release in GitHub with the tag created in the previous step and the changes in the CHANGELOG.md file.
139+
5. Merge the release branch into the main branch.
142140
143141
# License
144142

CHANGELOG.md

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

14+
## [2.1.0] - 2025-03-20
15+
16+
### Added
17+
18+
* feat: Add `ignore` input. It allows the user to ignore files by using glob patterns.
19+
20+
### Changed
21+
22+
* chore(deps): Bump @tid-xcut/markdown-confluence-sync from 1.1.1 to 1.2.1 (Add ignore option)
23+
1424
## [2.0.1] - 2025-03-18
1525

1626
### Changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ For example:
9494
mode: id
9595
docs-dir: '.'
9696
files-pattern: '*.md'
97+
ignore: 'node_modules/**;dist/**'
9798
files-metadata: |
9899
[
99100
{
@@ -178,6 +179,7 @@ The action accepts a configuration file in the root of the repository, and it ca
178179
| `docs-dir` | Path to the directory containing the markdown files | __Yes__ | |
179180
| `files-metadata` | Array of objects with the metadata of the files to sync, expressed as an stringified JSON (supports multiline). Each object must have at least the `path` property for identifying the file. For the rest of properties read the [markdown-confluence-sync docs](https://github.com/Telefonica/cross-confluence-tools/tree/main/components/markdown-confluence-sync#filesmetadata-property) | No | |
180181
| `files-pattern` | Pattern to filter the files to sync in flat or id mode | No | |
182+
| `ignore`| Semicolon separated list of [glob](https://github.com/cowboy/node-globule) patterns to ignore files. Matches are based on the current working directory | No | |
181183
| `confluence-url` | Confluence base URL | __Yes__ | |
182184
| `confluence-root-page-id` | ID of the Confluence page under which the pages will be synchronized | __Yes__ | |
183185
| `confluence-space-key` | Key of the Confluence space where the pages will be synced | __Yes__ | |
@@ -187,7 +189,7 @@ The action accepts a configuration file in the root of the repository, and it ca
187189
| `confluence-notice-template` | Template string to use for the notice message | No | |
188190
| `confluence-dry-run` | Dry run mode: Do not update Confluence pages. Only log pages to sync | No | `false `|
189191
| `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. It must be relative to the repository folder | No | `.` |
192+
| `cwd` | Current working directory. Path from where resolve `docs-dir`, `files-pattern`, `ignore`, and search for the configuration file. It must be relative to the repository folder | No | Repository root (`.`) |
191193

192194
> [!NOTE]
193195
> 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.

action.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ inputs:
2828
files-pattern:
2929
description: 'Pattern to filter the files to sync in flat mode'
3030
type: string
31+
ignore:
32+
description: 'Semicolon separated list of glob patterns to ignore files'
33+
type: string
3134
files-metadata:
3235
description: 'Metadata of the files to sync'
3336
type: string

0 commit comments

Comments
 (0)