Add GitHub action and Docker image for asciidoc-linter #14
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Related to #11 Add GitHub action and Docker image for AsciiDoc Linter. * **Dockerfile** - Create a Dockerfile to build a Docker image for the linter. - Use Python 3.9 as the base image. - Copy the project files into the Docker image. - Install the project dependencies. - Set the entry point to the linter CLI. * **GitHub Action Workflow** - Create a new GitHub action workflow file `.github/workflows/asciidoc-linter-action.yml`. - Use the Docker image to run the linter. - Trigger the action on push and pull request events to the main branch. - Define steps to build and run the Docker image. * **README.adoc** - Add instructions on how to use the linter as a GitHub action. - Add instructions on how to use the linter as a Docker image. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/docToolchain/asciidoc-linter/issues/11?shareId=XXXX-XXXX-XXXX-XXXX).
* **Dockerfile** - Use Python 3.9 as the base image - Copy the project files into the Docker image - Install the project dependencies - Set the entry point to the linter CLI * **GitHub Action** - Use the Docker image to run the linter - Trigger the action on pull requests and pushes to the main branch - Define the steps to build and run the Docker image * **README.adoc** - Add instructions on how to use the linter as a GitHub action - Add instructions on how to use the linter as a Docker image
* Install asciidoc-linter as described in the README file
* Change the entry point to `asciidoc-linter` in the Dockerfile
* Add `RUN pip install pyyaml` to Dockerfile to install pyyaml in the Docker image * Add `pip install pyyaml` to setup_test_environment.sh to install pyyaml in the test environment
* **Dockerfile** - Change entry point to `asciidoc-lint` from `asciidoc-linter` * **setup.py** - Add `pyyaml` to the list of dependencies - Change console script entry point to `asciidoc-linter` from `asciidoc-lint`
* Change ENTRYPOINT from "asciidoc-lint" to "asciidoc-linter"
ascheman
requested changes
Mar 3, 2025
There was a problem hiding this comment.
I suggest to add https://peps.python.org/pep-0518/ (or PEP in general) to the AI to make it follow recommended Python practices.
|
|
||
| # Install the project dependencies | ||
| RUN pip install --no-cache-dir -e . | ||
| RUN pip install pyyaml |
There was a problem hiding this comment.
Runtime dependencies should be part of pyproject.toml to satisfy arbitrary installations (not only Docker), cf. #15
|
|
||
| [source,bash] | ||
| ---- | ||
| docker build -t asciidoc-linter . |
There was a problem hiding this comment.
It would be nice to have a Docker compose.yml file which creates a tag for the new image so that it can easily be used by other projects as well.
| @@ -13,6 +13,7 @@ | |||
| "pytest-metadata", | |||
| "black", | |||
| "flake8", | |||
| "pyyaml", | |||
There was a problem hiding this comment.
Why is there a pyproject.toml and a setup.py which overlap?
|
Accidentally removed branch ... |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to #11
Add GitHub action and Docker image for AsciiDoc Linter.
Dockerfile
GitHub Action Workflow
.github/workflows/asciidoc-linter-action.yml.README.adoc
For more details, open the Copilot Workspace session.