Skip to content

Workflow documentation - #109

Open
rimi-itk wants to merge 34 commits into
developfrom
feature/github-actions-documentation
Open

Workflow documentation#109
rimi-itk wants to merge 34 commits into
developfrom
feature/github-actions-documentation

Conversation

@rimi-itk

@rimi-itkrimi-itk commented May 8, 2025

Copy link
Copy Markdown
Contributor

Adds information on project workflows in .github/workflows/README.workflows.md inside project templates, e.g templates/drupal-11/.github/workflows/README.workflows.md.

@rimi-itk
rimi-itk requested a review from cablemanMay 8, 2025 14:37
@rimi-itk
rimi-itkforce-pushed the feature/github-actions-documentation branch from 97b1082 to cd30e87CompareMay 8, 2025 19:55
@rimi-itk
rimi-itkforce-pushed the feature/github-actions-documentation branch from bf7df23 to 6f48820CompareMay 8, 2025 20:00
@rimi-itk
rimi-itk marked this pull request as ready for review May 9, 2025 07:35
Comment threadTaskfile.yml
# `peterdavehello/markdownlint`
# (https://hub.docker.com/r/peterdavehello/markdownlint)
MARKDOWNLINT_COMMAND: >-
docker run --rm --volume "$PWD":/md peterdavehello/markdownlint markdownlint --dot {{.GLOB}}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to look into this!

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, or just use peterdavehello/markdownlint (https://github.com/PeterDaveHello/docker-markdownlint). We only use it to lint Markdown and we don't do that our our servers, so I don't really understand why we need our own image – I suppose it has something to do with security.

Comment threadcompose.yaml
volumes:
- ./:/md

jinja2-cli:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this used for?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's used to generate the README.workflows.md files from task/Taskfile.github-actions.yml.

@cableman
cableman requested a review from turegjorupMay 9, 2025 07:42
@rimi-itk
rimi-itkforce-pushed the feature/github-actions-templates branch from e2ee3d3 to ea6598eCompareJune 2, 2025 11:20
Base automatically changed from feature/github-actions-templates to developJune 23, 2025 09:32
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@rimi-itk@cableman