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

Docs: Update notice migration file #1357

Merged
merged 6 commits into from
Apr 5, 2023
Merged

Conversation

isabelle-dr
Copy link
Contributor

@isabelle-dr isabelle-dr commented Mar 20, 2023

Summary:

As we're planning to decrease our release cycle, this file is there to help our users quickly see:

  • what changed in the notices from the version I am currently using to the version I am looking to upgrade to?
    • new notices
    • dropped notices
    • changes in severity

It also closes #1218

We believe this will ease the process for users that need to update their pipelines at each validator release.

Please make sure these boxes are checked before submitting your pull request - thanks!

  • [ ] Run the unit tests with gradle test to make sure you didn't break anything
  • Format the title like "feat: [new feature short description]". Title must follow the Conventional Commit Specification(https://www.conventionalcommits.org/en/v1.0.0/).
  • Linked all relevant issues
  • [ ] Include screenshot(s) showing how this pull request works and fixes the issue(s)

@isabelle-dr isabelle-dr added this to the 4.1.0 milestone Mar 20, 2023
Copy link
Contributor

@emmambd emmambd left a comment

Choose a reason for hiding this comment

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

This looks good! It looks like an old release note linked to one of the migration docs that will be deleted in this PR. I'm noting the link should be updated.

Suggestion: could the most recent version in NOTICE_MIGRATION.md be color coded so it's slightly easier to skim between versions? E.g green for new notices, orange for modified notices.

@isabelle-dr
Copy link
Contributor Author

@emmambd I have updated the link in the release notes, and I've made an attempt at making this table easier to read, PTAL!

I played around with colors but GitHub doesn't seem to support it, to the great despair of GitHub's community, apparently!

@CLAassistant
Copy link

CLAassistant commented Apr 5, 2023

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

@emmambd emmambd left a comment

Choose a reason for hiding this comment

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

New changes LGTM!

@isabelle-dr isabelle-dr merged commit 5f4ba0a into master Apr 5, 2023
13 checks passed
@isabelle-dr isabelle-dr deleted the update-migration-file branch April 5, 2023 15:06
KClough pushed a commit to JarvusInnovations/gtfs-validator that referenced this pull request Apr 7, 2023
* refactor migration file

* update documentation with new file

* fix wording

* Make easier to read

* remove colors

---------

Co-authored-by: Emma Blue <90632321+emmambd@users.noreply.github.com>
KClough added a commit that referenced this pull request Apr 13, 2023
* chore: fix deprecated dependency

* chore: auto-format

* feat: handle missing RULES.md

* feat: refactor upload process and handle more errors

* Add a more descriptive test failure message to NoticeFieldsTest. (#1369)

* Docs: Update notice migration file (#1357)

* refactor migration file

* update documentation with new file

* fix wording

* Make easier to read

* remove colors

---------

Co-authored-by: Emma Blue <90632321+emmambd@users.noreply.github.com>

* feat: Fail acceptance tests on significant change in warnings (#1377)

* Refactor logic out of of outputcomparator/cli/Main and into a new ValidationReportComparator class for easier testing.  In addition, update ValidationReportComparator to trigger a comparison error if changed warnings are above configured thresholds.

* Additional unit tests for ValidationReportComparator.

---------

Co-authored-by: Ryon Coleman <ryon55@gmail.com>
Co-authored-by: Brian Ferris <bdferris+v2@google.com>
Co-authored-by: isabelle-dr <isabelle@mobilitydata.org>
Co-authored-by: Emma Blue <90632321+emmambd@users.noreply.github.com>
Co-authored-by: David Gamez <1192523+davidgamez@users.noreply.github.com>
KClough added a commit that referenced this pull request Apr 18, 2023
…1384)

* chore: fix deprecated dependency

* chore: auto-format

* feat: handle missing RULES.md

* feat: refactor upload process and handle more errors

* Add a more descriptive test failure message to NoticeFieldsTest. (#1369)

* Docs: Update notice migration file (#1357)

* refactor migration file

* update documentation with new file

* fix wording

* Make easier to read

* remove colors

---------

Co-authored-by: Emma Blue <90632321+emmambd@users.noreply.github.com>

* feat: Fail acceptance tests on significant change in warnings (#1377)

* Refactor logic out of of outputcomparator/cli/Main and into a new ValidationReportComparator class for easier testing.  In addition, update ValidationReportComparator to trigger a comparison error if changed warnings are above configured thresholds.

* Additional unit tests for ValidationReportComparator.

* Add sentry script to static html header

* Add sentry script to web service

* Remove sentry properties from source control

---------

Co-authored-by: Ryon Coleman <ryon55@gmail.com>
Co-authored-by: Brian Ferris <bdferris+v2@google.com>
Co-authored-by: isabelle-dr <isabelle@mobilitydata.org>
Co-authored-by: Emma Blue <90632321+emmambd@users.noreply.github.com>
bradyhunsaker pushed a commit to bradyhunsaker/gtfs-validator that referenced this pull request Apr 25, 2023
* refactor migration file

* update documentation with new file

* fix wording

* Make easier to read

* remove colors

---------

Co-authored-by: Emma Blue <90632321+emmambd@users.noreply.github.com>
bradyhunsaker pushed a commit to bradyhunsaker/gtfs-validator that referenced this pull request Apr 25, 2023
* chore: fix deprecated dependency

* chore: auto-format

* feat: handle missing RULES.md

* feat: refactor upload process and handle more errors

* Add a more descriptive test failure message to NoticeFieldsTest. (MobilityData#1369)

* Docs: Update notice migration file (MobilityData#1357)

* refactor migration file

* update documentation with new file

* fix wording

* Make easier to read

* remove colors

---------

Co-authored-by: Emma Blue <90632321+emmambd@users.noreply.github.com>

* feat: Fail acceptance tests on significant change in warnings (MobilityData#1377)

* Refactor logic out of of outputcomparator/cli/Main and into a new ValidationReportComparator class for easier testing.  In addition, update ValidationReportComparator to trigger a comparison error if changed warnings are above configured thresholds.

* Additional unit tests for ValidationReportComparator.

---------

Co-authored-by: Ryon Coleman <ryon55@gmail.com>
Co-authored-by: Brian Ferris <bdferris+v2@google.com>
Co-authored-by: isabelle-dr <isabelle@mobilitydata.org>
Co-authored-by: Emma Blue <90632321+emmambd@users.noreply.github.com>
Co-authored-by: David Gamez <1192523+davidgamez@users.noreply.github.com>
bradyhunsaker pushed a commit to bradyhunsaker/gtfs-validator that referenced this pull request Apr 25, 2023
…obilityData#1384)

* chore: fix deprecated dependency

* chore: auto-format

* feat: handle missing RULES.md

* feat: refactor upload process and handle more errors

* Add a more descriptive test failure message to NoticeFieldsTest. (MobilityData#1369)

* Docs: Update notice migration file (MobilityData#1357)

* refactor migration file

* update documentation with new file

* fix wording

* Make easier to read

* remove colors

---------

Co-authored-by: Emma Blue <90632321+emmambd@users.noreply.github.com>

* feat: Fail acceptance tests on significant change in warnings (MobilityData#1377)

* Refactor logic out of of outputcomparator/cli/Main and into a new ValidationReportComparator class for easier testing.  In addition, update ValidationReportComparator to trigger a comparison error if changed warnings are above configured thresholds.

* Additional unit tests for ValidationReportComparator.

* Add sentry script to static html header

* Add sentry script to web service

* Remove sentry properties from source control

---------

Co-authored-by: Ryon Coleman <ryon55@gmail.com>
Co-authored-by: Brian Ferris <bdferris+v2@google.com>
Co-authored-by: isabelle-dr <isabelle@mobilitydata.org>
Co-authored-by: Emma Blue <90632321+emmambd@users.noreply.github.com>
isabelle-dr added a commit that referenced this pull request Apr 25, 2023
* chore: fix deprecated dependency

* chore: auto-format

* feat: handle missing RULES.md

* feat: refactor upload process and handle more errors

* Add a more descriptive test failure message to NoticeFieldsTest. (#1369)

* Docs: Update notice migration file (#1357)

* refactor migration file

* update documentation with new file

* fix wording

* Make easier to read

* remove colors

---------

Co-authored-by: Emma Blue <90632321+emmambd@users.noreply.github.com>

* feat: Fail acceptance tests on significant change in warnings (#1377)

* Refactor logic out of of outputcomparator/cli/Main and into a new ValidationReportComparator class for easier testing.  In addition, update ValidationReportComparator to trigger a comparison error if changed warnings are above configured thresholds.

* Additional unit tests for ValidationReportComparator.

* Add sentry script to static html header

* Add sentry script to web service

* Remove sentry properties from source control

* feat: add newrelic agent to web service

---------

Co-authored-by: Ryon Coleman <ryon55@gmail.com>
Co-authored-by: Brian Ferris <bdferris+v2@google.com>
Co-authored-by: isabelle-dr <isabelle@mobilitydata.org>
Co-authored-by: Emma Blue <90632321+emmambd@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

Update "Notice migration from V2.0.0 to V3.0.0" to use snake case and add later versions
3 participants