{"id":15649723,"url":"https://github.com/bhacaz/docs-as-code-confluence","last_synced_at":"2025-11-17T14:00:53.137Z","repository":{"id":46606081,"uuid":"431665912","full_name":"Bhacaz/docs-as-code-confluence","owner":"Bhacaz","description":"Publish the content of a folder to confluence Github Action","archived":false,"fork":false,"pushed_at":"2024-12-05T17:43:25.000Z","size":5311,"stargazers_count":39,"open_issues_count":3,"forks_count":18,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-03T00:09:13.338Z","etag":null,"topics":["actions","confluence","docs-as-code"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Bhacaz.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-25T00:26:49.000Z","updated_at":"2024-12-05T17:43:09.000Z","dependencies_parsed_at":"2024-05-17T16:03:46.287Z","dependency_job_id":null,"html_url":"https://github.com/Bhacaz/docs-as-code-confluence","commit_stats":{"total_commits":28,"total_committers":3,"mean_commits":9.333333333333334,"dds":0.1071428571428571,"last_synced_commit":"1f45c85f450e30ac2580a5d0fa88469839ebfe08"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bhacaz%2Fdocs-as-code-confluence","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bhacaz%2Fdocs-as-code-confluence/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bhacaz%2Fdocs-as-code-confluence/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bhacaz%2Fdocs-as-code-confluence/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Bhacaz","download_url":"https://codeload.github.com/Bhacaz/docs-as-code-confluence/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233327824,"owners_count":18659363,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","confluence","docs-as-code"],"created_at":"2024-10-03T12:31:22.718Z","updated_at":"2025-11-17T14:00:48.051Z","avatar_url":"https://github.com/Bhacaz.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docs as Code - Confluence\n\nPublish a folder of documentation to Confluence.\n\nCreate a Confluence Page for each markdown file. Each folder will create a _parent_ page to reflect\nthe directory structure.\n\n## Parameters\n\n| Name                  | Description | Required |\n|-----------------------| --- | --- |\n| `folder`              | The folder to sync | true |\n| `username`            | Confluence username or email | true |\n| `password`            | Confluence password or [API token](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/) | true |\n| `confluence-base-url` | Your Confluence URL (with `wiki`). Example: `https://mydomain.atlassian.net/wiki` | true |\n| `space-key`           | Confluence space key to publish the documentation. Located after `spaces` in the URL. `https://mydomain.atlassian.net/wiki/spaces/\u003c\u003c~1234\u003e\u003e`. \u003cbr\u003e Or in _Space settings_ \u003e _Space details_ \u003e _Key_. | true |\n| `parent-page-id`      | Page id under which the documentation will be published. Located after `pages` in the URL. `https://mydomain.atlassian.net/wiki/spaces/~1234/pages/\u003c\u003c1234\u003e\u003e/My+Parent+Page` | true |\n\n## TODO\n\n* Renaming a file\n* Moving/Removing a file\n* Not updating Confluence pages when there is no change\n* Add commit link to the new page version\n* Add markdown images with url source\n\n## Example of workflow\n\n```yml\nname: Sync Docs as Code - Confluence\non:\n  push:\n    branches:\n      - main\n    paths:\n      - 'docs/**'\njobs:\n  docs-as-code:\n    runs-on: ubuntu-latest\n    name: Sync Docs as Code - Confluence\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v4\n      - name: Sync Docs as Code - Confluence\n        uses: Bhacaz/docs-as-code-confluence@v3\n        with:\n          folder: docs\n          username: abc@xyz.com\n          password: ${{ secrets.API_TOKEN }}\n          confluence-base-url: https://mydomain.atlassian.net/wiki\n          space-key: ~1234\n          parent-page-id: 123456789\n```\n\n## Example of usage in a repository\n\n[Bhacaz/docs-as-code-confluence-demo](https://github.com/Bhacaz/docs-as-code-confluence-demo)\n\n## Alternatives\n\n* [markdown-confluence/publish-action](https://github.com/markdown-confluence/publish-action)\n* [mbovo/mark2confluence](https://github.com/mbovo/mark2confluence)\n\n## Development\n\n**Test**\n\n```bash\nnpm run test\n```\n\n**Build**\n\n```bash\nnpm run build\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbhacaz%2Fdocs-as-code-confluence","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbhacaz%2Fdocs-as-code-confluence","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbhacaz%2Fdocs-as-code-confluence/lists"}