generated from alshedivat/al-folio
-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Description
Description
To enhance the efficiency and reliability of the project, we need to automate the generation of book entries using a GitHub Actions workflow. This will ensure that the script runs automatically whenever changes are pushed to the repository, reducing the need for manual intervention and ensuring consistency.
Technical Information
List any technical details necessary for understanding or addressing the issue, such as context, background, or suggested approach to solution.
- Context: The current process for generating markdown files for book entries is manual, which is time-consuming and prone to errors.
- Background: A Python script has been developed to automate the creation of markdown files for book collections. This script can be integrated into a GitHub Actions workflow to automate its execution.
- Suggested Approach:
- Create a GitHub Actions workflow that triggers on push events to the main branch and can be manually triggered.
- Configure the workflow to use a Docker image that includes all necessary dependencies for running the script.
- Ensure the workflow commits and pushes the generated markdown files back to the repository.
Acceptance Criteria
- A GitHub Actions workflow is created to automate the generation of book entries.
- The workflow uses a Docker image that includes all necessary dependencies for running the script.
- The workflow triggers on push events to the working branch and can be manually triggered.
- The workflow commits and pushes the generated markdown files back to the repository.
- The workflow logs all actions, including file creation and any skipped files.
Metadata
Metadata
Assignees
Labels
featureNew featureNew feature
Type
Projects
Status
ReadyForDevelopment