- Motivation
- Mining Regimes
- Usage
- Action Configuration
- Action Outputs
- Project Setup
- Run Scripts Locally
- Run Pylint Check Locally
- Run Black Tool Locally
- Run Unit Test
- Code Coverage
- Releasing
- Support
- Contribution Guidelines
Addresses the need for continuously updated documentation accessible to all team members and stakeholders. Achieves this by extracting information directly from GitHub issues and integrating this functionality to deliver real-time, mdoc viewer capable formatted output. Ensures everyone has the most current project details, fostering better communication and efficiency throughout development.
This Generator supports multiple mining regimes, each with its own unique functionality. Read more about the regimes at their respective links:
Before we begin, ensure you have a GitHub Token with permission to fetch repository data such as Issues and Pull Requests.
See the default action step definition:
- name: Generate Living Documentation
id: generate_living_doc
uses: AbsaOSS/[email protected]
env:
GITHUB-TOKEN: ${{ secrets.REPOSITORIES_ACCESS_TOKEN }}
with:
# regimes de/activation
liv-doc-regime: falseSee the default action step definitions for each regime:
See the full example of action step definition (in example are used non-default values):
- name: Generate Living Documentation
id: generate_living_doc
uses: AbsaOSS/[email protected]
env:
GITHUB-TOKEN: ${{ secrets.REPOSITORIES_ACCESS_TOKEN }}
with:
liv-doc-regime: true # living documentation regime de/activation
verbose-logging: true # project verbose (debug) logging feature de/activation
# LivDoc Regime configuration
liv-doc-repositories: |
[
{
"organization-name": "fin-services",
"repository-name": "investment-app",
"query-labels": ["feature", "enhancement"],
"projects-title-filter": []
},
{
"organization-name": "health-analytics",
"repository-name": "patient-data-analysis",
"projects-title-filter": ["Health Data Analysis Project"]
},
{
"organization-name": "open-source-initiative",
"repository-name": "community-driven-project",
"query-labels": ["improvement"]
}
]
liv-doc-project-state-mining: true # project state mining feature de/activation
liv-doc-structured-output: true # structured output feature de/activation
liv-doc-group-output-by-topics: true # group output by topics feature de/activationThis section outlines the essential parameters that are common to all regimes a user can define.
Configure the action by customizing the following parameters based on your needs:
- REPOSITORIES_ACCESS_TOKEN:
- Description: GitHub access token for authentication, that has a permission to access all defined repositories / projects.
- Usage: Store it in the GitHub repository secrets and reference it in the workflow file using
${{ secrets.REPOSITORIES_ACCESS_TOKEN }}. - Example:
env: GITHUB-TOKEN: ${{ secrets.REPOSITORIES_ACCESS_TOKEN }}
The way how to generate and store a token into the GitHub repository secrets is described in the support chapter.
In this GitHub action, there are two types of user inputs:
- Base Inputs: Inputs that are common to all regimes.
- Regime Inputs: Inputs that are specific to a particular regime.
-
liv-doc-regime (required)
- Description: Enables or disables Living Documentation regime.
- Usage: Set to true to activate.
- Example:
with: liv-doc-regime: true
-
verbose-logging (optional,
default: false)- Description: Enables or disables verbose (debug) logging.
- Usage: Set to true to activate.
- Example:
with: verbose-logging: true
Regime-specific inputs are detailed in the respective regime's documentation:
The Living Documentation Generator action provides a key output that allows users to locate and access the generated documentation easily. This output can be utilized in various ways within your CI/CD pipeline to ensure the documentation is effectively distributed and accessible. The output-path can not be an empty string. It can not aim to the root and other project directories as well.
- output-path
- Description: This output provides the path to the directory where the generated living documentation files are stored.
- Usage:
- name: Generate Living Documentation id: generate_doc ... rest of the action definition ... - name: Output Documentation Path run: echo "Generated documentation path: ${{ steps.generate_doc.outputs.output-path }}"
If you need to build the action locally, follow these steps for project setup:
python3 --versionpython3 -m venv venv
source venv/bin/activate
pip install -r requirements.txtIf you need to run the scripts locally, follow these steps:
Create the shell file in the root directory. We will use run_script.sh.
touch run_script.shAdd the shebang line at the top of the sh script file.
#!/bin/sh
Set the configuration environment variables in the shell script following the structure below. The generator supports mining in multiple regimes, so you can use just the environment variables you need. Also make sure that the INPUT_GITHUB_TOKEN is configured in your environment variables.
# Essential environment variables for GitHub Action functionality
export INPUT_GITHUB_TOKEN=$(printenv GITHUB_TOKEN)
export INPUT_LIV_DOC_REGIME=true
export INPUT_VERBOSE_LOGGING=true
# Environment variables for LivDoc regime functionality
export INPUT_LIV_DOC_REPOSITORIES='[
{
"organization-name": "Organization Name",
"repository-name": "example-project",
"query-labels": ["feature", "bug"],
"projects-title-filter": ["Project Title 1"]
}
]'
export INPUT_LIV_DOC_PROJECT_STATE_MINING=true
export INPUT_LIV_DOC_STRUCTURED_OUTPUT=true
export INPUT_LIV_DOC_GROUP_OUTPUT_BY_TOPICS=true
For running the GitHub action incorporate these commands into the shell script and save it.
python3 main.py
From the terminal that is in the root of this project, make the script executable:
chmod +x run_script.sh./run_script.shThis project uses Pylint tool for static code analysis.
Pylint analyses your code without actually running it.
It checks for errors, enforces, coding standards, looks for code smells etc.
We do exclude the tests/ file from the pylint check.
Pylint displays a global evaluation score for the code, rated out of a maximum score of 10.0. We are aiming to keep our code quality high above the score 9.5.
Follow these steps to run Pylint check locally:
From terminal in the root of the project, run the following command:
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txtThis command will also install a Pylint tool, since it is listed in the project requirements.
Run Pylint on all files that are currently tracked by Git in the project.
pylint $(git ls-files '*.py')To run Pylint on a specific file, follow the pattern pylint <path_to_file>/<name_of_file>.py.
Example:
pylint living_documentation_regime/living_documentation_regime.pyThis is the console expected output example after running the tool:
************* Module main
main.py:30:0: C0116: Missing function or method docstring (missing-function-docstring)
------------------------------------------------------------------
Your code has been rated at 9.41/10 (previous run: 8.82/10, +0.59)
This project uses the Black tool for code formatting. Black aims for consistency, generality, readability and reducing git diffs. The coding style used can be viewed as a strict subset of PEP 8.
The project root file pyproject.toml defines the Black tool configuration.
In this project we are accepting the line length of 120 characters.
We also do exclude the tests/ file from the black formatting.
Follow these steps to format your code with Black locally:
From terminal in the root of the project, run the following command:
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txtThis command will also install a Black tool, since it is listed in the project requirements.
Run Black on all files that are currently tracked by Git in the project.
black $(git ls-files '*.py')To run Black on a specific file, follow the pattern black <path_to_file>/<name_of_file>.py.
Example:
black living_documentation_regime/living_documentation_regime.pyThis is the console expected output example after running the tool:
All done! ✨ 🍰 ✨
1 file reformatted.
Unit tests are written using Pytest framework. To run alle the tests, use the following command:
pytest tests/You can modify the directory to control the level of detail or granularity as per your needs.
To run specific test, write the command following the pattern below:
pytest tests/utils/test_utils.py::test_make_issue_keyThis project uses pytest-cov plugin to generate test coverage reports.
The objective of the project is to achieve a minimal score of 80 %. We do exclude the tests/ file from the coverage report.
To generate the coverage report, run the following command:
pytest --cov=. tests/ --cov-fail-under=80 --cov-report=htmlSee the coverage report on the path:
open htmlcov/index.htmlThis project uses GitHub Actions for deployment draft creation. The deployment process is semi-automated by a workflow defined in .github/workflows/release_draft.yml.
- Trigger the workflow: The
release_draft.ymlworkflow is triggered on workflow_dispatch. - Create a new draft release: The workflow creates a new draft release in the repository.
- Finalize the release draft: Edit the draft release to add a title, description, and any other necessary details related to GitHub Action.
- Publish the release: Once the draft is ready, publish the release to make it available to the public.
This section aims to help the user walk through different processes, such as:
- Go to your GitHub account settings.
- Click on the
Developer settingstab in the left sidebar. - In the left sidebar, click on
Personal access tokensand chooseTokens (classic). - Click on the
Generate new tokenbutton and chooseGenerate new token (classic). - Optional - Add a note, what is token for and choose token expiration.
- Select ONLY bold scope options below:
- workflow
- write:packages
- read:packages
- admin:org
- read:org
- manage_runners:org
- admin:public_key
- read:public_key
- admin:repo_hook
- read:repo_hook
- admin:enterprise
- manage_runners:enterprise
- read:enterprise
- audit_log
- read:audit_log
- project
- read:project
- Copy the token value somewhere, because you won't be able to see it again.
- Authorize new token to organization you want to fetch from.
- Go to the GitHub repository, from which you want to run the GitHub Action.
- Click on the
Settingstab in the top bar. - In the left sidebar, click on
Secrets and variables>Actions. - Click on the
New repository secretbutton. - Name the token
REPOSITORIES_ACCESS_TOKENand paste the token value.
We welcome contributions to the Living Documentation Generator! Whether you're fixing bugs, improving documentation, or proposing new features, your help is appreciated.
Before contributing, please review our contribution guidelines for more detailed information.
This project is licensed under the Apache License 2.0. It is a liberal license that allows you great freedom in using, modifying, and distributing this software, while also providing an express grant of patent rights from contributors to users.
For more details, see the LICENSE file in the repository.
If you need help with using or contributing to Living Documentation Generator Action, or if you have any questions or feedback, don't hesitate to reach out:
- Issue Tracker: For technical issues or feature requests, use the GitHub Issues page.
- Discussion Forum: For general questions and discussions, join our GitHub Discussions forum.