Skip to content

doc: Automatically update DAGs in documentation#1880

Merged
lkstrp merged 8 commits intomasterfrom
ci-dag
Nov 7, 2025
Merged

doc: Automatically update DAGs in documentation#1880
lkstrp merged 8 commits intomasterfrom
ci-dag

Conversation

@euronion
Copy link
Copy Markdown
Contributor

@euronion euronion commented Nov 4, 2025

Closes #1847 .

Changes proposed in this Pull Request

For simplicity I plugged it into the test.yaml GitHub CI action. Happy to move it somewhere else.

Checklist

  • I tested my contribution locally and it works as intended.
  • Code and workflow changes are sufficiently documented.
  • [n/a] Changed dependencies are added to envs/environment.yaml.
  • [n/a] Changes in configuration options are added in config/config.default.yaml.
  • [n/a] Changes in configuration options are documented in doc/configtables/*.csv.
  • [n/a] Sources of newly added data are documented in doc/data_sources.rst.
  • A release note doc/release_notes.rst is added.

@euronion euronion requested a review from lkstrp November 4, 2025 10:48
@fneum
Copy link
Copy Markdown
Member

fneum commented Nov 4, 2025

Great idea!

Copy link
Copy Markdown
Member

@lkstrp lkstrp left a comment

Choose a reason for hiding this comment

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

This will not work. There is currently no logic for committing back to somewhere, so nothing would happen. And putting this in test.yaml would result in one commit per trigger. We only want to trigger this per release, as done in the other repos.

I can add the proper workflow

@lkstrp lkstrp self-assigned this Nov 4, 2025
@euronion
Copy link
Copy Markdown
Contributor Author

euronion commented Nov 4, 2025

This will not work. There is currently no logic for committing back to somewhere, so nothing would happen. And putting this in test.yaml would result in one commit per trigger. We only want to trigger this per release, as done in the other repos.

I can add the proper workflow

Yeah, I can see that it won't work. At least the make update-dags works locally ;)
I've taken the CI from PyPSA/PyPSA, unlikely that it will work, but I guess that is direction to go.

@lkstrp lkstrp enabled auto-merge (squash) November 7, 2025 12:52
@lkstrp lkstrp disabled auto-merge November 7, 2025 13:41
@lkstrp lkstrp merged commit a1dee3f into master Nov 7, 2025
5 of 6 checks passed
@lkstrp lkstrp deleted the ci-dag branch November 7, 2025 13:41
lmezilis pushed a commit to lmezilis/pypsa-eur that referenced this pull request Nov 10, 2025
* doc: Automatically update DAGs in documentation

* doc: Update release notes

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* I find working with the CI always tricky

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* some adjustments

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: lkstrp <[email protected]>
toniseibold pushed a commit that referenced this pull request Dec 1, 2025
* doc: Automatically update DAGs in documentation

* doc: Update release notes

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* I find working with the CI always tricky

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* some adjustments

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: lkstrp <[email protected]>
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.

doc: Add up-to-date DAG

3 participants