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

New README in migrations directory #1576

Merged
merged 23 commits into from
Dec 17, 2024
Merged

New README in migrations directory #1576

merged 23 commits into from
Dec 17, 2024

Conversation

i-oden
Copy link
Member

@i-oden i-oden commented Dec 4, 2024

Read this before submitting the PR

  1. Always create a Draft PR first
  2. Go through sections 1-5 below, fill them in and check all the boxes
  3. Make sure that the branch is updated; if there's an "Update branch" button at the bottom of the PR, rebase or update branch.
  4. When all boxes are checked, information is filled in, and the branch is updated: mark as Ready For Review and tag reviewers (top right)
  5. Once there is a submitted review, implement the suggestions (if reasonable, otherwise discuss) and request an new review.

If there is a field which you are unsure about, enter the edit mode of this description or go to the PR template; There are invisible comments providing descriptions which may be of help.

1. Description / Summary

While @rv0lt was working on #1562, he added a README to the migrations directory with some steps regarding how to generate the migrations. There was already some information in the root README, but that file has a lot of other information too. In order to make things clearer and easier to find, I'm now moving the information from the root README to the migrations directory, including some of the information that @rv0lt added, while also including and updating the details that were previously written.

While adding this markdown file, I also linked to the migrations/README.md file from the root README, which made me think of correct/incorrect links, which is why I've also added the Linkspector action.

2. Jira task / GitHub issue

Link to the github issue or add the Jira task ID here.

3. Type of change

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

Check the relevant boxes below. For an explanation of the different sections, enter edit mode of this PR description template.

  • New feature
    • Breaking: Why / How? Add info here.
    • Non-breaking
  • Database change: Remember the to include a new migration version, or explain here why it's not needed.
  • 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
  • Prettier
  • Yamllint
  • Tests
  • CodeQL
  • Trivy
  • Snyk

@i-oden i-oden changed the title updated info and link to readme New README in migrations directory Dec 5, 2024
@i-oden i-oden marked this pull request as ready for review December 5, 2024 10:00
@i-oden i-oden requested a review from a team as a code owner December 5, 2024 10:00
@i-oden i-oden self-assigned this Dec 5, 2024
@i-oden i-oden merged commit 74bf774 into dev Dec 17, 2024
16 checks passed
@i-oden i-oden deleted the migrations-readme branch December 17, 2024 10:28
Copy link

codecov bot commented Dec 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 0.00%. Comparing base (a396807) to head (457a3bf).
Report is 24 commits behind head on dev.

Additional details and impacted files
@@     Coverage Diff     @@
##   dev   #1576   +/-   ##
===========================
===========================

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

@i-oden i-oden added the skip-changelog For release template label Jan 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog For release template
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants