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

documentation: improve changelog generation #2738

Merged
merged 1 commit into from
Mar 4, 2022

Conversation

PascalRepond
Copy link
Contributor

  • add default params file to improve use of github_changelog_generator
  • rename CHANGES.md to CHANGELOG.md for consistency across projects

Code review check list

  • Commit message template compliance.
  • Commit message without typos.
  • File names.
  • Functions names.
  • Functions docstrings.
  • Unnecessary commited files?
  • Cypress tests successful?

@PascalRepond PascalRepond requested review from jma and pronguen March 2, 2022 10:19
- add default params file to improve use of github_changelog_generator
- rename CHANGES.md to CHANGELOG.md for consistency across projects
Copy link
Contributor

@jma jma left a comment

Choose a reason for hiding this comment

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

It would be nice to do the same on the other projects.

release-branch=staging

# Limit issues fetched so as to not reach secondary API limit
max-issues=300
Copy link
Contributor

Choose a reason for hiding this comment

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

Difficult to know if this can be an issue.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

From what I've gathered, it is a problem for generating a complete changelog but not to update an existing one. The first issues to be fetched are the most recent ones. The API limit is hit when fetching commit and issue events at around 1400, a comfortable margin.

@PascalRepond PascalRepond merged commit b9cb7ca into rero:staging Mar 4, 2022
@PascalRepond PascalRepond deleted the rep-changelog branch March 4, 2022 06:49
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