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-1942 update docs for testing migration #691

Merged
merged 2 commits into from
May 28, 2024

Conversation

aishling-scilifelab
Copy link
Collaborator

@aishling-scilifelab aishling-scilifelab commented May 24, 2024

1. Description / Summary

Updating the user-facing documentation for the migration of the Testing instance.
Also, in a separate commit, removed a sentence that said there was no risk. Can move this commit to its own branch, if preferred.

2. Jira task / GitHub issue

DDS-1942

3. Type of change

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

  • New feature
    • Breaking: Why / How? Add info here.
    • Non-breaking
  • Bug fix
  • Security Alert fix
    • Package update
      • Major version update
  • Documentation
  • Workflow
  • Tests only

4. Additional information

5. Actions / Scans

Check the boxes when the specified checks have passed.

For information on what the different checks do and how to fix it if they're failing, enter edit mode of this description or go to the PR template.

  • Black
  • Pylint
  • Prettier
  • Yamllint
  • Tests
  • TestPyPI
  • CodeQL
  • Trivy
  • Snyk

@rv0lt
Copy link
Member

rv0lt commented May 24, 2024

I think Sprintlog is always necessary to add an entry to keep track

@aishling-scilifelab
Copy link
Collaborator Author

aishling-scilifelab commented May 24, 2024

I think Sprintlog is always necessary to add an entry to keep track

I assume the way to use the sprintlog is:

  • Add a new section with the sprint dates
  • Add a line for each individual PR

Then, when we do a release we digest the info in the sprint logs into user-facing text for the CHANGELOG.rst?

Edit: Will interactive rebase the branch to incorporate that change.

@rv0lt
Copy link
Member

rv0lt commented May 24, 2024

Yes, add a new line per PR. With the same format as the other ones. You can run prettier to check the style, otherwise the lint will fail.

Then, on release day. In the changelog will only be mentioned changes that will be seen/affected by the user (ex: Changes on the Actions will not be mentioned there).

Copy link
Member

@valyo valyo left a comment

Choose a reason for hiding this comment

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

Looks good, only thing needed is a sprintlog entry

@aishling-scilifelab aishling-scilifelab force-pushed the DDS-1942-update-docs-for-testing-migration branch from dd306ef to f94e37b Compare May 27, 2024 07:49
@aishling-scilifelab aishling-scilifelab requested a review from valyo May 27, 2024 07:58
@aishling-scilifelab
Copy link
Collaborator Author

@valyo @rv0lt SPRINTLOG.md updated.

SPRINTLOG.md Outdated Show resolved Hide resolved
@aishling-scilifelab aishling-scilifelab force-pushed the DDS-1942-update-docs-for-testing-migration branch from f94e37b to ad5d519 Compare May 27, 2024 08:23
@aishling-scilifelab aishling-scilifelab requested a review from valyo May 27, 2024 08:57
@aishling-scilifelab aishling-scilifelab force-pushed the DDS-1942-update-docs-for-testing-migration branch from ad5d519 to 94ff246 Compare May 27, 2024 08:59
Copy link

codecov bot commented May 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 47.74%. Comparing base (62b668e) to head (94ff246).
Report is 9 commits behind head on dev.

Current head 94ff246 differs from pull request most recent head 8f65813

Please upload reports for the commit 8f65813 to get more accurate results.

Additional details and impacted files
@@            Coverage Diff             @@
##              dev     #691      +/-   ##
==========================================
- Coverage   47.76%   47.74%   -0.02%     
==========================================
  Files          31       31              
  Lines        2887     2886       -1     
==========================================
- Hits         1379     1378       -1     
  Misses       1508     1508              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

- When talking about the Testing instance of DDS, the existing doc
claims there is *no* risk. Bit pedantic but there is never no risk.
- Furthermore, as the users of this Testing instance should not be using
it for any sensitive deliveries, this should not be an issue.
- The testing instance != dev and use 'testing', rather than test.
- Update mentioned URLs from https://dds-dev.dckube3.scilifelab.se/ to
https://testing.delivery.scilifelab.se/ as the testing instance is
migrating to this new address.
- Update SPRINGLOG.md
@aishling-scilifelab aishling-scilifelab force-pushed the DDS-1942-update-docs-for-testing-migration branch from 94ff246 to 8f65813 Compare May 28, 2024 07:57
@aishling-scilifelab aishling-scilifelab merged commit 2db1088 into dev May 28, 2024
15 checks passed
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