Skip to content

add dependency-update workflow template (fixes #683)#756

Open
Rimsha2535 wants to merge 21 commits intomainfrom
feature/dependency-update-workflow
Open

add dependency-update workflow template (fixes #683)#756
Rimsha2535 wants to merge 21 commits intomainfrom
feature/dependency-update-workflow

Conversation

@Rimsha2535
Copy link
Copy Markdown

@Rimsha2535 Rimsha2535 commented Mar 19, 2026

Fixes #683

Checklist

Note: If any of the items in the checklist are not relevant to your PR, just check the box.

For any Pull Request

Is the following correct:

  • the title of the Pull Request?
  • the title of the corresponding issue?
  • there are no other open [Pull Requests](../../../../pulls) for the same update/change?
  • that the issue which this Pull Request fixes ("Fixes...") is mentioned?

When Changes Were Made

Did you:

  • update the changelog?
  • update the cookiecutter-template?
  • update the implementation?
  • check coverage and add tests: unit tests and, if relevant, integration tests?
  • update the User Guide & other documentation?
  • resolve any failing CI criteria (incl. Sonar quality gate)?

When Preparing a Release

Have you:

  • thought about version number (major, minor, patch)?
  • checked Exasol packages for updates and resolved open vulnerabilities, if easily possible?

Notes

  • Changelog was not updated because this is an internal workflow/template change.
  • No separate cookiecutter-template update was needed because the workflow template itself was updated.
  • CI checks are currently failing and will be fixed.

@Rimsha2535 Rimsha2535 requested a review from kratz00 March 19, 2026 14:30
@kratz00 kratz00 changed the title add dependency-update workflow template add dependency-update workflow template (fixes #683) Mar 19, 2026
@Rimsha2535 Rimsha2535 requested a review from ArBridgeman March 30, 2026 12:41
Comment thread .github/workflows/dependency-update.yml
Comment thread exasol/toolbox/templates/github/workflows/dependency-update.yml
Comment thread exasol/toolbox/templates/github/workflows/dependency-update.yml Outdated
Comment thread exasol/toolbox/templates/github/workflows/dependency-update.yml Outdated
Comment thread .github/workflows/dependency-update.yml
Comment thread doc/github_actions/dependency_update.rst Outdated
Comment thread doc/github_actions/dependency_update.rst Outdated
Comment thread exasol/toolbox/templates/github/workflows/dependency-update.yml Outdated
Comment thread test/integration/project-template/nox_test.py
Comment thread exasol/toolbox/templates/github/workflows/dependency-update.yml Outdated
Comment thread exasol/toolbox/templates/github/workflows/dependency-update.yml Outdated
Comment thread exasol/toolbox/templates/github/workflows/dependency-update.yml Outdated
@Rimsha2535 Rimsha2535 requested a review from ArBridgeman April 14, 2026 14:35
Comment thread doc/user_guide/features/github_workflows/index.rst Outdated
Comment thread doc/user_guide/features/github_workflows/index.rst Outdated
Comment thread doc/user_guide/features/github_workflows/index.rst Outdated
Comment thread doc/user_guide/features/github_workflows/index.rst Outdated
Comment thread doc/user_guide/features/github_workflows/index.rst
Comment thread .github/workflows/dependency-update.yml
@ArBridgeman
Copy link
Copy Markdown
Collaborator

ArBridgeman commented Apr 15, 2026

The GitHub workflow code looked good, but it's always good test, so here are those tests done via
another branch (nearly identical to this one):

Use cases:

  1. ✅ No vulnerability detected, so no update
    https://github.com/exasol/python-toolbox/actions/runs/24443525540/job/71414050584
  2. ✅ Vulnerability detected, do an update, & create PR
    https://github.com/exasol/python-toolbox/actions/runs/24444147768/job/71416082184

Example PR:
#780

Like @ckunki said, we likely need to modify this text more to tell the user what to do. But it sounds like this would be done in a later effort.

Comment thread exasol/toolbox/templates/github/workflows/dependency-update.yml Outdated
Comment thread .github/workflows/dependency-update.yml Outdated
Comment thread .github/workflows/dependency-update.yml
Copy link
Copy Markdown
Contributor

@ckunki ckunki left a comment

Choose a reason for hiding this comment

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

Added 2 comments

Comment thread test/integration/tools/workflow_integration_test.py Outdated
Comment thread .github/workflows/dependency-update.yml Outdated
Comment thread .github/workflows/dependency-update.yml
Comment thread .github/workflows/dependency-update.yml
Comment thread .github/workflows/dependency-update.yml
Comment thread .github/workflows/dependency-update.yml Outdated
Comment thread .github/workflows/dependency-update.yml
Comment thread .github/workflows/dependency-update.yml Outdated
Comment thread .github/workflows/dependency-update.yml Outdated
Comment thread .github/workflows/dependency-update.yml Outdated
Comment thread .github/workflows/dependency-update.yml Outdated
Rimsha2535 and others added 6 commits May 6, 2026 10:44
Co-authored-by: Christoph Kuhnke <christoph.kuhnke@exasol.com>
Co-authored-by: Christoph Kuhnke <christoph.kuhnke@exasol.com>
Co-authored-by: Christoph Kuhnke <christoph.kuhnke@exasol.com>
Co-authored-by: Christoph Kuhnke <christoph.kuhnke@exasol.com>
Co-authored-by: Christoph Kuhnke <christoph.kuhnke@exasol.com>
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented May 6, 2026

@Rimsha2535 Rimsha2535 requested review from ArBridgeman and ckunki and removed request for ArBridgeman May 6, 2026 09:05
status: '${{ job.status }}'
token: '${{ secrets.GITHUB_TOKEN }}'
notification_title: 'Dependency update for {repo} created a Pull Request'
status: '${{ job.status }}',
Copy link
Copy Markdown
Collaborator

@ArBridgeman ArBridgeman May 6, 2026

Choose a reason for hiding this comment

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

duplicate field

Suggested change
status: '${{ job.status }}',

token: '${{ secrets.GITHUB_TOKEN }}'
notification_title: 'Dependency update for {repo} created a Pull Request'
status: '${{ job.status }}',
token: '${{ secrets.GITHUB_TOKEN }}',
Copy link
Copy Markdown
Collaborator

@ArBridgeman ArBridgeman May 6, 2026

Choose a reason for hiding this comment

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

duplicate field

Suggested change
token: '${{ secrets.GITHUB_TOKEN }}',

notification_title: 'Dependency update for {repo} created a Pull Request'
status: '${{ job.status }}',
token: '${{ secrets.GITHUB_TOKEN }}',
notification_title: 'Dependency update for {repo} created a Pull Request',
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

duplicate field

Suggested change
notification_title: 'Dependency update for {repo} created a Pull Request',


echo "pr_url=$PR_URL" >> "$GITHUB_OUTPUT"

pr_url=$(gh pr create \
Copy link
Copy Markdown
Collaborator

@ArBridgeman ArBridgeman May 6, 2026

Choose a reason for hiding this comment

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

not needed

Suggested change
pr_url=$(gh pr create \

echo "pr_url=$PR_URL" >> "$GITHUB_OUTPUT"

pr_url=$(gh pr create \
--base "$BASE_BRANCH" \
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

not needed

Suggested change
--base "$BASE_BRANCH" \


pr_url=$(gh pr create \
--base "$BASE_BRANCH" \
--title "Update dependencies to fix vulnerabilities ($(date '+%Y-%m-%d'))" \
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

not needed

Suggested change
--title "Update dependencies to fix vulnerabilities ($(date '+%Y-%m-%d'))" \

pr_url=$(gh pr create \
--base "$BASE_BRANCH" \
--title "Update dependencies to fix vulnerabilities ($(date '+%Y-%m-%d'))" \
--body "Automated dependency update for \`poetry.lock\`.)
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

not needed

Suggested change
--body "Automated dependency update for \`poetry.lock\`.)

--base "$BASE_BRANCH" \
--title "Update dependencies to fix vulnerabilities ($(date '+%Y-%m-%d'))" \
--body "Automated dependency update for \`poetry.lock\`.)
echo "pr_url=$pr_url" >> "$GITHUB_OUTPUT"
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

not needed

Suggested change
echo "pr_url=$pr_url" >> "$GITHUB_OUTPUT"

echo "pr_url=$pr_url" >> "$GITHUB_OUTPUT"
This PR was created by the dependency update workflow after running:
- \`poetry run -- nox -s dependency:audit\`
- \`poetry update\`"
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

not needed

Suggested change
- \`poetry update\`"

--body "Automated dependency update for \`poetry.lock\`.)
echo "pr_url=$pr_url" >> "$GITHUB_OUTPUT"
This PR was created by the dependency update workflow after running:
- \`poetry run -- nox -s dependency:audit\`
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

not needed

Suggested change
- \`poetry run -- nox -s dependency:audit\`

--title "Update dependencies to fix vulnerabilities ($(date '+%Y-%m-%d'))" \
--body "Automated dependency update for \`poetry.lock\`.)
echo "pr_url=$pr_url" >> "$GITHUB_OUTPUT"
This PR was created by the dependency update workflow after running:
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

not needed

Suggested change
This PR was created by the dependency update workflow after running:

permissions:
contents: read

test-python-environment:
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.

Why has this been removed, now?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

@ckunki Sorry, there was a merge conflict in that file and I think this line was accidentally removed while resolving it.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks, this shouldn't be removed. It's related to the PTB not fully supporting GitHub workflow changes.
So the poetry run -- nox -s workflow:generate -- all overwrites & we need to manually ensure it stays 😿
@Rimsha2535 lmk if you want to pair briefly on this one.

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.

Create a template workflow to execute poetry update

4 participants