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

Dds 1473 GitHub Actions not able to generate the documentation #650

Merged
merged 26 commits into from
Sep 21, 2023

Conversation

rv0lt
Copy link
Member

@rv0lt rv0lt commented Sep 20, 2023

Before submitting this PR

  1. Description: The GitHub Actions to generate the documentation wasn't working. The issue was found to be in a problem with the dependencies. The container need certain modules and libraries to be installed. As well as proper modules to convert the svg images.
  2. Jira task / GitHub issue: https://scilifelab.atlassian.net/browse/DDS-1473
  3. How to test: Trigger the actions
  4. Type of change: Check the relevant boxes in the section below
  5. Add docstrings and comments to code, even if you personally think it's obvious.

What type of change(s) does the PR contain?

  • New feature
    • Breaking: Please describe the reason for the break and how we can fix it.
    • Non-breaking
  • Bug fix
    • Breaking: Please describe the reason for the break and how we can fix it.
    • Non-breaking
  • Security Alert fix
  • Documentation
  • Tests (only)
  • Workflow

Checklist

  • Sprintlog
    • Added
    • Not needed (E.g. PR contains only tests)
  • Rebase / Update / Merge from base branch (the branch from which the current is forked)
    • Done
    • Not needed
  • Blocking PRs
    • Merged
    • No blocking PRs
  • PR to master branch

Actions / Scans

  • Black: Python code formatter. Does not execute. Only tests.
    Run black . locally to execute formatting.
    • Passed
  • Pylint: Python code linter. Does not execute. Only tests.
    Fix code producing warnings. Code must get 10/10.
    • Warnings fixed
    • Passed
  • Prettier: General code formatter. Our use case: MD and yaml mainly.
    Run npx prettier --write . locally to execute formatting.
    • Passed
  • Yamllint: Linting of yaml files.
    • Passed
  • Tests: Pytest to verify that functionality works as expected.
    • New tests added
    • No new tests
    • Passed
  • TestPyPi: Build CLI and publish to TestPyPi in order to verify before release.
    • Passed
  • CodeQL: Scan for security vulnerabilities, bugs, errors
    • New alerts: Go through them and either fix, dismiss och ignore. Add reasoning in items below.
    • Alerts fixed: What?
    • Alerts ignored / dismissed: Why?
    • Passed
  • Trivy: Security scanner
    • New alerts: Go through them and either fix, dismiss och ignore. Add reasoning in items below.
    • Alerts fixed: What?
    • Alerts ignored / dismissed: Why?
    • Passed
  • Snyk: Security scanner
    • New alerts: Go through them and either fix, dismiss och ignore. Add reasoning in items below.
    • Alerts fixed: What?
    • Alerts ignored / dismissed: Why?
    • Passed

@rv0lt rv0lt self-assigned this Sep 20, 2023
@codecov
Copy link

codecov bot commented Sep 20, 2023

Codecov Report

Merging #650 (5658a54) into dev (cb32c16) will increase coverage by 0.10%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##              dev     #650      +/-   ##
==========================================
+ Coverage   46.63%   46.74%   +0.10%     
==========================================
  Files          31       31              
  Lines        2792     2792              
==========================================
+ Hits         1302     1305       +3     
+ Misses       1490     1487       -3     

see 1 file with indirect coverage changes

@rv0lt
Copy link
Member Author

rv0lt commented Sep 20, 2023

The build won't work unless there is a release due to this parameter:

upload_url: ${{ github.event.release.upload_url }}

However, the fails that were occurring before that point are solved.

@rv0lt rv0lt marked this pull request as ready for review September 20, 2023 14:05
@rv0lt rv0lt requested a review from i-oden September 20, 2023 14:06
@rv0lt rv0lt requested a review from valyo September 20, 2023 14:06
Copy link
Member

@i-oden i-oden left a comment

Choose a reason for hiding this comment

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

Nice! I just have a couple of questions.

.github/workflows/release-cli.yml Show resolved Hide resolved
docs/conf.py Show resolved Hide resolved
Copy link
Member

@i-oden i-oden left a comment

Choose a reason for hiding this comment

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

And also add a sprintlog row btw

Copy link
Member

@i-oden i-oden left a comment

Choose a reason for hiding this comment

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

Good job solving this! Approved, you can merge

@rv0lt
Copy link
Member Author

rv0lt commented Sep 21, 2023

Good job solving this! Approved, you can merge

It says The base branch restricts merging to authorized users

@i-oden
Copy link
Member

i-oden commented Sep 21, 2023

Good job solving this! Approved, you can merge

It says The base branch restricts merging to authorized users

Aha.. Interesting. I'll merge then, and check if we have different settings for the dds_cli and dds_web

@i-oden i-oden merged commit 0daaff2 into dev Sep 21, 2023
17 checks passed
@i-oden i-oden deleted the dds-1473-fix-client-documentation-github-actions branch September 21, 2023 08:17
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