Skip to content

Workflow documentation #109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 34 commits into
base: develop
Choose a base branch
from

Conversation

rimi-itk
Copy link
Contributor

@rimi-itk rimi-itk commented May 8, 2025

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 cableman May 8, 2025 14:37
@rimi-itk rimi-itk force-pushed the feature/github-actions-documentation branch from 97b1082 to cd30e87 Compare May 8, 2025 19:55
@rimi-itk rimi-itk force-pushed the feature/github-actions-documentation branch from bf7df23 to 6f48820 Compare May 8, 2025 20:00
@rimi-itk rimi-itk marked this pull request as ready for review May 9, 2025 07:35
# `peterdavehello/markdownlint`
# (https://hub.docker.com/r/peterdavehello/markdownlint)
MARKDOWNLINT_COMMAND: >-
docker run --rm --volume "$PWD":/md peterdavehello/markdownlint markdownlint --dot {{.GLOB}}
Copy link
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
Contributor Author

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.

@@ -5,3 +5,12 @@ services:
- dev
volumes:
- ./:/md

jinja2-cli:
Copy link
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
Contributor Author

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 turegjorup May 9, 2025 07:42
@rimi-itk rimi-itk force-pushed the feature/github-actions-templates branch from e2ee3d3 to ea6598e Compare June 2, 2025 11:20
Base automatically changed from feature/github-actions-templates to develop June 23, 2025 09:32
Sign up for free to 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