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

[FIX] fix typo in PR title which got into src/CHANGES.md #1148

Closed
wants to merge 1 commit into from

Conversation

yarikoptic
Copy link
Collaborator

That leads to failing CI as in
https://github.com/bids-standard/bids-specification/pull/1120/files#file-src-changes-md-L13

Ideally we should add spell checking for PR title, but those would keep changing,
would need separate workflow and react to changes to titles and then have no way
to easily say "ignore". May be src/CHANGES.md should be excluded... separate issue would
that be

That leads to failing CI as in
https://github.com/bids-standard/bids-specification/pull/1120/files#file-src-changes-md-L13

Ideally we should add spell checking for PR title, but those would keep changing,
would need separate workflow and react to changes to titles and then have no way
to easily say "ignore". May be src/CHANGES.md should be excluded... separate issue would
that be
@tsalo
Copy link
Member

tsalo commented Jul 18, 2022

Won't the changelog updater automatically fix it since @effigies corrected the PR title, the next time there's a merged PR to trigger it?

@effigies
Copy link
Collaborator

Fixed in 4f32cf0.

@effigies effigies closed this Jul 18, 2022
@yarikoptic
Copy link
Collaborator Author

Won't the changelog updater automatically fix it since @effigies corrected the PR title, the next time there's a merged PR to trigger it?

I hope that changelog updated considers only relevant PRs since the last release and not all PRs historically since that would be growing burden to avoid. ... indeed looking at https://github.com/bids-standard/bids-specification/blob/HEAD/.circleci/config.yml#L176 it considers only the last merge commit, so no retroactive fixes

@effigies
Copy link
Collaborator

It runs when there are merges into master. It will happily modify any entry since the first GitHub version if we go and change the titles.

@yarikoptic
Copy link
Collaborator Author

It will happily modify any entry since the first GitHub version if we go and change the titles.

how would it do that if it works only on the latest one (git log -1)??? point blind me to the code

@effigies
Copy link
Collaborator

github_changelog_generator \
--user bids-standard \
--project bids-specification \
--token ${CHANGE_TOKEN} \
--output ~/changelog_build/CHANGES.md \
--base ~/project/src/pregh-changes.md \
--header-label "# Changelog" \
--no-issues \
--no-issues-wo-labels \
--no-filter-by-milestone \
--no-compare-link \
--pr-label "" \
--release-branch master

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