https://github.com/dodevops/confluence-outdated
Constant validation of Confluence document outdates
https://github.com/dodevops/confluence-outdated
Last synced: 10 months ago
JSON representation
Constant validation of Confluence document outdates
- Host: GitHub
- URL: https://github.com/dodevops/confluence-outdated
- Owner: dodevops
- Created: 2020-06-24T12:23:05.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-11-18T07:57:14.000Z (over 1 year ago)
- Last Synced: 2025-03-11T16:23:01.556Z (over 1 year ago)
- Language: TypeScript
- Size: 95.7 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# confluence-outdated - Constant validation of Confluence document outdates
[](https://github.com/dodevops/confluence-outdated/actions/workflows/docker-publish.yml)
## Introduction
_confluence-outdated_ searches a Confluence space for documents that haven't been updated for a specified time and
notifies the author of the last version of each document or a separate page maintainer.
## Usage
_confluence-outdated_ can be used with Docker to quickly run it without any further dependencies.
docker run --rm -it ghcr.io/dodevops/confluence-outdated:main
## Configuration Document
_confluence-outdated_ needs several things configured before it can start working. To simplify this,
_confluence-outdated_ reads its configuration from a Confluence document.
The structure of this document is based on Panels and tables. To ease the creation of this document,
_confluence-outdated_ includes a command to create a template document:
confluence-outdated CreateConfigurationDocument --url --user --password --space --title --parentId
Example:
confluence-outdated CreateConfigurationDocument --url https://example.com/confluence --user somebody --password secret --space CM --title "My configuration document" --parentId 12345
The command will output the page ID for the configuration document and a link to it.
The configuration is based on several panels. The configuration for the different panels is as follows:
### Panel "Configuration"
- Space: The key of the space where _confluence-outdated_ should check for outdated documents
- Domain: A default domain, that will be appended to all author usernames (should be set if the usernames aren't email addresses themselves)
- NotificationFrom: "
- Write a test that tests the feature or bug
- Run the test => the new test should fail
- Write or fix the code for the change
- Run the test again => the new test should succeed
- Push and create a pull request
To test and build this package, simply use grunt:
grunt test