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: Minor documentation refactoring on the new changelog process. #2162

Merged

Conversation

marcosuma
Copy link
Collaborator

@marcosuma marcosuma commented Apr 17, 2024

Description

Please include a summary of the fix/feature/change, including any relevant motivation and context.

Link to any related issue(s): https://jira.mongodb.org/browse/CLOUDP-243940

Type of change:

  • Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
  • New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR. A migration guide must be created or updated if the new feature will go in a major version.
  • Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR. A migration guide must be created or updated.
  • This change requires a documentation update
  • Documentation fix/enhancement

Required Checklist:

  • I have signed the MongoDB CLA
  • I have read the contributing guides
  • I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
  • I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
  • I have added any necessary documentation (if appropriate)
  • I have run make fmt and formatted my code
  • If changes include deprecations or removals, I defined an isolated PR with a relevant title as it will be used in the auto-generated changelog.
  • If changes include removal or addition of 3rd party GitHub actions, I updated our internal document. Reach out to the APIx Integration slack channel to get access to the internal document.

Further comments

@marcosuma marcosuma marked this pull request as ready for review April 17, 2024 10:38
@marcosuma marcosuma requested a review from a team as a code owner April 17, 2024 10:38
@marcosuma marcosuma changed the title chore: Minor documentation refactoring on the new changelog process. fix: Minor documentation refactoring on the new changelog process. Apr 17, 2024
@github-actions github-actions bot added the bug label Apr 17, 2024
@marcosuma marcosuma changed the title fix: Minor documentation refactoring on the new changelog process. chore: Minor documentation refactoring on the new changelog process. Apr 17, 2024
@marcosuma
Copy link
Collaborator Author

marcosuma commented Apr 17, 2024

Ref: https://github.com/mongodb/terraform-provider-mongodbatlas/actions/runs/8720632791/job/23922580319?pr=2162

Now error is printed like this:

2024/04/17 10:53:21 Changelog file .changelog/2162.txt not found due to the following reason: open .changelog/2162.txt: no such file or directory.
Have you ran the `make generate-changelog-entry` command?
If this PR doesn't need a changelog entry file, consider using label skip-changelog-check.
Read contributing guides (https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/contributing/changelog-process.md) for more info.
exit status 1

@github-actions github-actions bot removed the bug label Apr 17, 2024
@lantoli
Copy link
Member

lantoli commented Apr 17, 2024

I personally prefer to have the error detail (errFile) at the end of the message. It's normally additional info that you may not need, and I think we can get a clearer message.

Copy link
Member

@AgustinBettati AgustinBettati left a comment

Choose a reason for hiding this comment

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

LGTM

@marcosuma marcosuma merged commit 0945f29 into master Apr 18, 2024
31 checks passed
@marcosuma marcosuma deleted the CLOUDP-243940-improve-changelog-process-error-language branch April 18, 2024 04:39
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.

4 participants