Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,8 @@ But we use the __merge commit strategy for merging PRs to the main branch from t
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.
2. Updating the CHANGELOG.md file with the changes in the new version.
3. 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
Expand All @@ -137,8 +135,8 @@ Once the PR is approved and __merged into the release branch__, a project mainta
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.
4. Create a new release in GitHub with the tag created in the previous step and the changes in the CHANGELOG.md file.
5. Merge the release branch into the main branch.

# License

Expand Down
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
#### Deprecated
#### Removed

## [2.1.0] - 2025-03-20

### Added

* feat: Add `ignore` input. It allows the user to ignore files by using glob patterns.

### Changed

* chore(deps): Bump @tid-xcut/markdown-confluence-sync from 1.1.1 to 1.2.1 (Add ignore option)

## [2.0.1] - 2025-03-18

### Changed
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ For example:
mode: id
docs-dir: '.'
files-pattern: '*.md'
ignore: 'node_modules/**;dist/**'
files-metadata: |
[
{
Expand Down Expand Up @@ -178,6 +179,7 @@ The action accepts a configuration file in the root of the repository, and it ca
| `docs-dir` | Path to the directory containing the markdown files | __Yes__ | |
| `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 | |
| `files-pattern` | Pattern to filter the files to sync in flat or id mode | No | |
| `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 | |
| `confluence-url` | Confluence base URL | __Yes__ | |
| `confluence-root-page-id` | ID of the Confluence page under which the pages will be synchronized | __Yes__ | |
| `confluence-space-key` | Key of the Confluence space where the pages will be synced | __Yes__ | |
Expand All @@ -187,7 +189,7 @@ The action accepts a configuration file in the root of the repository, and it ca
| `confluence-notice-template` | Template string to use for the notice message | No | |
| `confluence-dry-run` | Dry run mode: Do not update Confluence pages. Only log pages to sync | No | `false `|
| `log-level` | Log level: `silent`, `silly`, `debug`, `verbose`, `info`, `warn`, `error` | No | `info` |
| `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 | `.` |
| `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 (`.`) |

> [!NOTE]
> 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.
Expand Down
3 changes: 3 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ inputs:
files-pattern:
description: 'Pattern to filter the files to sync in flat mode'
type: string
ignore:
description: 'Semicolon separated list of glob patterns to ignore files'
type: string
files-metadata:
description: 'Metadata of the files to sync'
type: string
Expand Down
Loading