Skip to content

refactor!: inherit mdfluence CLI parser, rename env vars, add auth model #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
geopanther merged 6 commits into from
May 13, 2026
Merged

refactor!: inherit mdfluence CLI parser, rename env vars, add auth model #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
967c649
refactor!: inherit mdfluence CLI parser, rename env vars, add auth model
geopanther Apr 28, 2026
64feada
docs: update env var names, CLI options, and action inputs
geopanther Apr 28, 2026
97ebe85
fix(sec): Fixed gitpython security findings
geopanther May 5, 2026
29b339c
fix(confluence): scope --parent-id/--parent-title to root-level pages…
geopanther May 7, 2026
1cc705c
fix(deps): bump dependency floors and pin urllib3>=2.7.0 for security
geopanther May 12, 2026
ec8b9b9
feat(confluence): align with all mdfluence CLI options
geopanther May 12, 2026
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
75 changes: 45 additions & 30 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,22 @@ gitfluence --beautify-folders . # pass mdfluence options

## Environment Variables

| Variable | Required | Description |
| ----------------------- | -------- | ----------------------------------------------------------- |
| `CONFLUENCE_PROD_HOST` | Yes | Production Confluence REST API base URL |
| `CONFLUENCE_PROD_TOKEN` | Yes\* | PAT for production writes |
| `CONFLUENCE_INT_HOST` | No | Integration Confluence REST API base URL (defaults to prod) |
| `CONFLUENCE_INT_TOKEN` | No\* | PAT for integration writes |
| `CONFLUENCE_SPACE` | Yes\* | Confluence space key |
| Variable | Required | Description |
| ------------------------- | -------- | ----------------------------------------------------------- |
| `CONFLUENCE_HOST` | Yes | Confluence REST API base URL |
| `CONFLUENCE_TOKEN` | Yes\* | PAT for Confluence (token > username/password) |
| `CONFLUENCE_USERNAME` | No | Username for basic auth |
| `CONFLUENCE_PASSWORD` | No | Password for basic auth |
| `CONFLUENCE_INT_HOST` | No | Integration Confluence REST API base URL (defaults to prod) |
| `CONFLUENCE_INT_TOKEN` | No\* | PAT for integration writes |
| `CONFLUENCE_INT_USERNAME` | No | Username for integration basic auth |
| `CONFLUENCE_INT_PASSWORD` | No | Password for integration basic auth |
| `CONFLUENCE_SPACE` | Yes\* | Confluence space key |

\* On `--dry-run`, missing host defaults to `https://dummy.example.com/api`, missing tokens default to `dummy` and missing space defaults to `DRY_RUN`. In interactive mode, missing values are prompted.

Auth decision (per target): token > username+password > prompt > dry-run dummy.

<details open>
<summary><b>macOS / Linux</b></summary>

Expand Down Expand Up @@ -113,40 +119,47 @@ jobs:
with:
repo_path: "."
extra_args: "--beautify-folders"
confluence_prod_host: ${{ secrets.CONFLUENCE_PROD_HOST }}
confluence_prod_token: ${{ secrets.CONFLUENCE_PROD_TOKEN }}
confluence_host: ${{ secrets.CONFLUENCE_HOST }}
confluence_token: ${{ secrets.CONFLUENCE_TOKEN }}
confluence_space: ${{ secrets.CONFLUENCE_SPACE }}
```

### Action inputs

| Input | Default | Description |
| ----------------------- | ---------- | -------------------------------- |
| `repo_path` | `"."` | Root directory to sync |
| `dry_run` | `"false"` | Preview mode |
| `gitfluence_version` | `"latest"` | Version to install |
| `python_version` | `"3.12"` | Python version |
| `extra_args` | `""` | Additional CLI args |
| `confluence_prod_host` | — | Confluence production host URL |
| `confluence_prod_token` | — | Confluence production API token |
| `confluence_int_host` | `""` | Confluence integration host URL |
| `confluence_int_token` | `""` | Confluence integration API token |
| `confluence_space` | — | Confluence space key |
| Input | Default | Description |
| ---------------------- | ---------- | -------------------------------- |
| `repo_path` | `"."` | Root directory to sync |
| `dry_run` | `"false"` | Preview mode |
| `gitfluence_version` | `"latest"` | Version to install |
| `python_version` | `"3.12"` | Python version |
| `extra_args` | `""` | Additional CLI args |
| `confluence_host` | — | Confluence host URL |
| `confluence_token` | — | Confluence API token |
| `confluence_int_host` | `""` | Confluence integration host URL |
| `confluence_int_token` | `""` | Confluence integration API token |
| `confluence_space` | — | Confluence space key |

## CLI Options

### gitfluence-specific options

These options are **not** available in mdfluence:

| Option | Description |
| ------------------ | ----------------------------------------------------------- |
| `repo_path` | Root directory of the git working tree to sync (positional) |
| `--space` | Override Confluence space key |
| `--prefix` | Override auto-detected page title prefix |
| `-v` / `--verbose` | Enable debug logging |
| `--no-preface` | Disable the default preface (DO-NOT-EDIT banner) |
| `--no-postface` | Disable the default postface (metadata footer) |
| Option | Description |
| ------------------------------ | ----------------------------------------------------------- |
| `repo_path` | Root directory of the git working tree to sync (positional) |
| `--space` | Override Confluence space key |
| `--prefix` | Override auto-detected page title prefix |
| `-v` / `--verbose` / `--debug` | Enable debug logging |
| `-n` (alias for `--dry-run`) | Print what would be done without calling API |
| `--no-preface` | Disable the default preface (DO-NOT-EDIT banner) |
| `--no-postface` | Disable the default postface (metadata footer) |
| `--host-int` | Integration Confluence host (env: CONFLUENCE_INT_HOST) |
| `--token-int` | Integration Confluence token (env: CONFLUENCE_INT_TOKEN) |
| `--username-int` | Integration Confluence username |
| `--password-int` | Integration Confluence password |

> **Note:** `--page-id` is not supported. Pages are managed by directory hierarchy. Use `--parent-id` to anchor pages under a specific parent.

### Differences from mdfluence defaults

Expand All @@ -170,7 +183,9 @@ Preface and postface behave differently from mdfluence:

All remaining mdfluence options are passed through unchanged:

**Page information:** `--title`, `--content-type`, `--message`, `--minor-edit`, `--strip-top-header`, `--remove-text-newlines`, `--replace-all-labels`
**Login:** `--host` / `-o`, `--token`, `--username` / `-u`, `--password` / `-p`, `--insecure`

**Page information:** `--title`, `--content-type` (choices: page/blogpost), `--message`, `--minor-edit`, `--strip-top-header`, `--remove-text-newlines`, `--replace-all-labels`

**Parent selection** (mutually exclusive): `--parent-title` / `--parent-id` / `--top-level`

Expand Down
12 changes: 6 additions & 6 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ inputs:
description: "Additional CLI arguments passed to gitfluence (e.g. '--skip-empty --beautify-folders')"
required: false
default: ""
confluence_prod_host:
description: "Confluence production host URL"
confluence_host:
description: "Confluence host URL"
required: true
confluence_prod_token:
description: "Confluence production API token"
confluence_token:
description: "Confluence API token"
required: true
confluence_int_host:
description: "Confluence integration host URL"
Expand Down Expand Up @@ -56,8 +56,8 @@ runs:
- name: Sync to Confluence
shell: bash
env:
CONFLUENCE_PROD_HOST: ${{ inputs.confluence_prod_host }}
CONFLUENCE_PROD_TOKEN: ${{ inputs.confluence_prod_token }}
CONFLUENCE_HOST: ${{ inputs.confluence_host }}
CONFLUENCE_TOKEN: ${{ inputs.confluence_token }}
CONFLUENCE_INT_HOST: ${{ inputs.confluence_int_host }}
CONFLUENCE_INT_TOKEN: ${{ inputs.confluence_int_token }}
CONFLUENCE_SPACE: ${{ inputs.confluence_space }}
Expand Down
Loading
Loading