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

chore: Add CHANGELOG github workflow #837

Merged
merged 9 commits into from
Aug 8, 2023
Merged

Conversation

svetlanabrennan
Copy link
Contributor

@svetlanabrennan svetlanabrennan commented Aug 7, 2023

Adding a changelog action that valids if a PR updates a changelog by using the newrelic/release-toolkit/validate-markdown@v1.

Relates to this PR: #836

@svetlanabrennan svetlanabrennan added the ci/skip-e2e E2E tests will be skipped for this PR label Aug 7, 2023
@svetlanabrennan svetlanabrennan requested a review from a team August 7, 2023 19:58
@svetlanabrennan svetlanabrennan changed the title Add changelog github workflow chore: Add CHANGELOG github workflow Aug 7, 2023

- name: Check if CHANGELOG is valid
uses: newrelic/release-toolkit/validate-markdown@v1

Copy link
Contributor

Choose a reason for hiding this comment

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

Have you tested this works as intended? Reading the documentation it looks like it only checks what has been introduced in the Unreleased section follows the right pattern. What if it is empty?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've tested this on one of my test personal repos. If the Unreleased section is empty then that's fine - it'll pass. It's just the L3 headers can't be empty.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok, so it is still honor system

@juanjjaramillo juanjjaramillo changed the base branch from main to fix-changelog August 8, 2023 18:48
Base automatically changed from fix-changelog to main August 8, 2023 18:54
@svetlanabrennan svetlanabrennan merged commit c10d4ed into main Aug 8, 2023
12 checks passed
@svetlanabrennan svetlanabrennan deleted the add-changelog-action branch August 8, 2023 19:34
csongnr pushed a commit that referenced this pull request Nov 9, 2023
* Add changelog github workflow

* fix typo

* Update changelog action

* undue contributing file changes

* Fix lint

* Update changelog.yml

* Add changelog

* Update changelog entry to include link
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci/skip-e2e E2E tests will be skipped for this PR Skip Changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants