Skip to content
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

(feat): reuseable workflows for static puml / mermaid files #164

Closed
wants to merge 26 commits into from

Conversation

FaGru3n
Copy link
Contributor

@FaGru3n FaGru3n commented Jul 6, 2023

Description

.github/workflows/reusable-generate-mermaid-svg.yaml

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

  • DEPENDENCIES are up to date. Dash license tool. Committers can open IP issues for restricted libs.
  • Copyright and license header are present on all affected files

FaGru3n, Mercedes-Benz Tech Innovation GmbH, legal info/Impressum

.github/workflows/reusable-generate-mermaid-svg.yaml Outdated Show resolved Hide resolved
do
mmdc -i $file -o ${file%.*}.svg
echo "${file%.*}.svg"
git add ${file%.*}.svg
Copy link
Contributor

Choose a reason for hiding this comment

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

I am unsure, what this is doing. git add, without commit? Is this needed, it there is an git-auto-commit-action
In general I still think, that it is not a good idea to autocommit things that where generated from a PR.
The minimal change, that I would want to see here, is an environment variable that controls, whether or not the auto-commit is done. It should default to false

Copy link
Contributor Author

Choose a reason for hiding this comment

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

at this step it will only staged, in case of there are more files that have changes.
At the current point this workflow just keep the static files updated.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

---
 title: workflow currently works
---
flowchart TD
    A[Reason: I want to change puml / mmd ] --> B(create PR)
    B --> C(someone approve pr on codelines)
    C --> D(merge pr)
    D --> E(Workflow checks that there are changed puml/mmd codefiles)
    E --> F(workflow provides new static files )
    F --> G(update static files on main)
Loading

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
evegufy and others added 4 commits July 10, 2023 16:34
…167)

- add example workflows to check dependencies for yarn and dotnet
the workflows also provide a quite easy option to update the DEPENDENCIES file (without committing on the feature branch via bot or opening another PR, I didn't like both options): once all the previous step were successful so that no restricted dependencies are in the DEPENDENCIES file anymore, the last step uploads the updated DEPENDENCIES file to the workflow as downloadable artifact which can then be easily committed.
@FaGru3n FaGru3n marked this pull request as draft July 18, 2023 11:32
@FaGru3n FaGru3n closed this Jul 20, 2023
@FaGru3n FaGru3n deleted the feat/reuseable_workflows_static_files branch September 8, 2023 13:54
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.

3 participants