{"id":20757634,"url":"https://github.com/dodevops/confluence-outdated","last_synced_at":"2025-08-16T22:34:19.689Z","repository":{"id":38613828,"uuid":"274662222","full_name":"dodevops/confluence-outdated","owner":"dodevops","description":"Constant validation of Confluence document outdates","archived":false,"fork":false,"pushed_at":"2024-11-18T07:57:14.000Z","size":98,"stargazers_count":0,"open_issues_count":11,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-11T16:23:01.556Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dodevops.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2020-06-24T12:23:05.000Z","updated_at":"2024-11-18T07:50:59.000Z","dependencies_parsed_at":"2023-11-21T10:30:11.621Z","dependency_job_id":"9ba4e0ca-6669-4dc3-a2a2-085e28d21dda","html_url":"https://github.com/dodevops/confluence-outdated","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/dodevops/confluence-outdated","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dodevops%2Fconfluence-outdated","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dodevops%2Fconfluence-outdated/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dodevops%2Fconfluence-outdated/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dodevops%2Fconfluence-outdated/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dodevops","download_url":"https://codeload.github.com/dodevops/confluence-outdated/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dodevops%2Fconfluence-outdated/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270781200,"owners_count":24643805,"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","status":"online","status_checked_at":"2025-08-16T02:00:11.002Z","response_time":91,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-17T09:43:27.466Z","updated_at":"2025-08-16T22:34:19.661Z","avatar_url":"https://github.com/dodevops.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# confluence-outdated - Constant validation of Confluence document outdates\n\n[![Docker](https://github.com/dodevops/confluence-outdated/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/dodevops/confluence-outdated/actions/workflows/docker-publish.yml)\n\n## Introduction\n\n_confluence-outdated_ searches a Confluence space for documents that haven't been updated for a specified time and\nnotifies the author of the last version of each document or a separate page maintainer.\n\n## Usage\n\n_confluence-outdated_ can be used with Docker to quickly run it without any further dependencies.\n\n    docker run --rm -it ghcr.io/dodevops/confluence-outdated:main \u003carguments\u003e \n\n## Configuration Document\n\n_confluence-outdated_ needs several things configured before it can start working. To simplify this, \n_confluence-outdated_ reads its configuration from a Confluence document.\n\nThe structure of this document is based on Panels and tables. To ease the creation of this document,\n_confluence-outdated_ includes a command to create a template document:\n\n    confluence-outdated CreateConfigurationDocument --url \u003cConfluence base URL\u003e --user \u003cUsername\u003e --password \u003cPassword\u003e --space \u003cKey of space that should hold the document\u003e --title \u003cTitle for the configuration document\u003e --parentId \u003cPage ID that the configuration document is place under\u003e\n\nExample:\n\n    confluence-outdated CreateConfigurationDocument --url https://example.com/confluence --user somebody --password secret --space CM --title \"My configuration document\" --parentId 12345\n\nThe command will output the page ID for the configuration document and a link to it.\n\nThe configuration is based on several panels. The configuration for the different panels is as follows:\n\n### Panel \"Configuration\"\n\n- Space: The key of the space where _confluence-outdated_ should check for outdated documents\n- Domain: A default domain, that will be appended to all author usernames (should be set if the usernames aren't email addresses themselves)\n- NotificationFrom: \u003cThe address used as the sender in the notification mails\n\n### Panel \"Checks\"\n\nA table of checks that will be carried out.\n\n- Labels: A list of all labels (separated by ,) that a checked document has to match\n- MaxAge: The maximum age of a checked document. If a document was modified before that, a notification is send\n\n### Panel \"Maintainer\"\n\nA table of maintainers for pages.\n\n- PagePattern: A regular expression that is matched against the full document path. Parent pages are separated through a \"/\".\n- Maintainer: The users that should receive all notifications for pages matching this pattern (separated by ,). You can \n  use `_lastauthor` to reference the last author of the page and `_creator` to reference the first author of the page.\n\n### Panel \"Exceptions\"\n\nA list of regular expressions that are matched against all document paths. If a pattern matches, that document will be\nexcluded from notifications.\n\n### Panel \"Notification Template\"\n\nThis panel includes two child panels which hold [Handlebars](https://handlebarsjs.com/guide/) templates for the\nsubject and the body of the notification mails.\n\nThey will be provided with the following context:\n\n* author: E-Mail address of the recipient\n* documentsCount: The number of documents that are outdated for this recipient\n* multipleDocuments: A boolean whether there are multiple documents or just one\n* documents: An array of [this object](https://github.com/dodevops/confluence-outdated/blob/master/lib/api/DocumentInfo.ts#L6)\n\n## Usage\n\nAfter the configuration document is properly setup, run *confluence-outdated* on a regular basis:\n\n    confluence-outdated Check --url https://example.com/confluence --user somebody --password secret -i 123456 -s \"smtp://localhost:25/?ignoreTLS=true\"\n\nThis will fetch the confluence document with the id 123456 as the configuration and check all required documentation as\nconfigured. The SMTP url is based on the [nodemailer smtp transport](https://nodemailer.com/smtp/).\n\n## Development\n\nThe tests subdirectory contain unit tests run by mocha for all parts of the api. If you want to help developing, please\nfollow the following workflow:\n\n- Create an issue describing the bug or feature\n- For this repository\n- Create a branch named \"issue-\u003cissue number\u003e\"\n- Write a test that tests the feature or bug\n- Run the test =\u003e the new test should fail\n- Write or fix the code for the change\n- Run the test again =\u003e the new test should succeed\n- Push and create a pull request\n\nTo test and build this package, simply use grunt:\n\n    grunt test\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdodevops%2Fconfluence-outdated","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdodevops%2Fconfluence-outdated","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdodevops%2Fconfluence-outdated/lists"}