Skip to content

fix(notifications): update docs to remove yaml validation issue and some cosmetic update #2846

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

vagrawal-newrelic
Copy link
Contributor

@vagrawal-newrelic vagrawal-newrelic commented Apr 3, 2025

Description

Please include a summary of the change and which issue is fixed (if relevant).
Updated docs for notification destination and notification channel to remove yaml validation issue and some cosmetic update

Type of change

Docs update
Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist:

Please delete options that are not relevant.

  • My commit message follows conventional commits
  • My code is formatted to Go standards
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes. Go here for instructions on running tests locally.

How to test this change?

Please describe how to test your changes. Include any relevant steps in the UI, HCL file(s), commands, etc

https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/notification_destination
Validate the changes in this URL

Copy link

github-actions bot commented Apr 3, 2025

❌ Invalid Conventional Commits Detected

The following commits do not follow the Conventional Commits format:


9e82690 - fix(notification_channel): Remove [] from microsoft_teams heading
a0afc66 - fix(Notification_destination): Cosmetic update
b92c608 - fix(notification_destination): Update doc to fix syntax issue
7960ba4 - fix(notification_channel): Update doc to fix syntax error

Please update these commit messages to follow the format:
<type>[optional scope]: <description>

Valid types: build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test

6 similar comments
Copy link

github-actions bot commented Apr 3, 2025

❌ Invalid Conventional Commits Detected

The following commits do not follow the Conventional Commits format:


9e82690 - fix(notification_channel): Remove [] from microsoft_teams heading
a0afc66 - fix(Notification_destination): Cosmetic update
b92c608 - fix(notification_destination): Update doc to fix syntax issue
7960ba4 - fix(notification_channel): Update doc to fix syntax error

Please update these commit messages to follow the format:
<type>[optional scope]: <description>

Valid types: build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test

Copy link

github-actions bot commented Apr 3, 2025

❌ Invalid Conventional Commits Detected

The following commits do not follow the Conventional Commits format:


9e82690 - fix(notification_channel): Remove [] from microsoft_teams heading
a0afc66 - fix(Notification_destination): Cosmetic update
b92c608 - fix(notification_destination): Update doc to fix syntax issue
7960ba4 - fix(notification_channel): Update doc to fix syntax error

Please update these commit messages to follow the format:
<type>[optional scope]: <description>

Valid types: build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test

Copy link

github-actions bot commented Apr 3, 2025

❌ Invalid Conventional Commits Detected

The following commits do not follow the Conventional Commits format:


9e82690 - fix(notification_channel): Remove [] from microsoft_teams heading
a0afc66 - fix(Notification_destination): Cosmetic update
b92c608 - fix(notification_destination): Update doc to fix syntax issue
7960ba4 - fix(notification_channel): Update doc to fix syntax error

Please update these commit messages to follow the format:
<type>[optional scope]: <description>

Valid types: build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test

Copy link

github-actions bot commented Apr 3, 2025

❌ Invalid Conventional Commits Detected

The following commits do not follow the Conventional Commits format:


9e82690 - fix(notification_channel): Remove [] from microsoft_teams heading
a0afc66 - fix(Notification_destination): Cosmetic update
b92c608 - fix(notification_destination): Update doc to fix syntax issue
7960ba4 - fix(notification_channel): Update doc to fix syntax error

Please update these commit messages to follow the format:
<type>[optional scope]: <description>

Valid types: build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test

Copy link

github-actions bot commented Apr 3, 2025

❌ Invalid Conventional Commits Detected

The following commits do not follow the Conventional Commits format:


9e82690 - fix(notification_channel): Remove [] from microsoft_teams heading
a0afc66 - fix(Notification_destination): Cosmetic update
b92c608 - fix(notification_destination): Update doc to fix syntax issue
7960ba4 - fix(notification_channel): Update doc to fix syntax error

Please update these commit messages to follow the format:
<type>[optional scope]: <description>

Valid types: build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test

Copy link

github-actions bot commented Apr 3, 2025

❌ Invalid Conventional Commits Detected

The following commits do not follow the Conventional Commits format:


9e82690 - fix(notification_channel): Remove [] from microsoft_teams heading
a0afc66 - fix(Notification_destination): Cosmetic update
b92c608 - fix(notification_destination): Update doc to fix syntax issue
7960ba4 - fix(notification_channel): Update doc to fix syntax error

Please update these commit messages to follow the format:
<type>[optional scope]: <description>

Valid types: build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test

@codecov-commenter
Copy link

codecov-commenter commented Apr 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 30.56%. Comparing base (ea955ac) to head (1cd259c).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2846   +/-   ##
=======================================
  Coverage   30.56%   30.56%           
=======================================
  Files         104      104           
  Lines       28601    28601           
=======================================
  Hits         8741     8741           
  Misses      19686    19686           
  Partials      174      174           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@pranav-new-relic pranav-new-relic changed the title fix(notifications): Update docs to remove yaml validation issue and some cosmetic update fix(notifications): update docs to remove yaml validation issue and some cosmetic update Apr 7, 2025
Copy link

github-actions bot commented Apr 7, 2025

❌ Invalid Conventional Commits Detected

The following commits do not follow the Conventional Commits format:


9e82690 - fix(notification_channel): Remove [] from microsoft_teams heading
a0afc66 - fix(Notification_destination): Cosmetic update
b92c608 - fix(notification_destination): Update doc to fix syntax issue
7960ba4 - fix(notification_channel): Update doc to fix syntax error

Please update these commit messages to follow the format:
<type>[optional scope]: <description>

Valid types: build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test

Copy link

github-actions bot commented Apr 8, 2025

❌ Invalid Conventional Commits Detected

The following commits do not follow the Conventional Commits format:


1cd259c - fix(notification_channel): Remove [] from microsoft_teams heading
733fd6d - fix(Notification_destination): Cosmetic update
3e50d89 - fix(notification_destination): Update doc to fix syntax issue
fa4aaee - fix(notification_channel): Update doc to fix syntax error

Please update these commit messages to follow the format:
<type>[optional scope]: <description>

Valid types: build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test

@pranav-new-relic
Copy link
Member

notes for @pranav-new-relic: changes from #2821 do work here, no integration test runs since no code files have been changed. The messaging does need some cosmetic changes though

@pranav-new-relic
Copy link
Member

@vagrawal-newrelic please don't mind the noise here, needing this PR for some experimentation ...

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