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

docs-issue-generation: docs issues are not being created for commits with multiple release notes #84434

Closed
jlinder opened this issue Jul 14, 2022 · 2 comments · Fixed by #85490
Assignees
Labels
C-bug Code not up to spec/doc, specs & docs deemed correct. Solution expected to change code/behavior. T-dev-inf

Comments

@jlinder
Copy link
Collaborator

jlinder commented Jul 14, 2022

Describe the problem

The docs-issue-generation program does not create docs issues for a commit with multiple release notes:

The logs for the TC runs that didn't create docs issues have no information about what it found.

Expected behavior

Docs issues should have been created for #83107 and #83507.

Additional context

It'd be great if the program could output some information about what it did to verify it's working as expected.

Jira issue: CRDB-17658

Epic DEVINF-261

@jlinder jlinder added C-bug Code not up to spec/doc, specs & docs deemed correct. Solution expected to change code/behavior. T-dev-inf labels Jul 14, 2022
@nickvigilante
Copy link
Contributor

@jlinder cockroachdb/docs#14376 was the docs ticket created for #83423. It was just closed shortly after opening by Stephanie. No issue there.

For #83507, there are two release notes within the commit message. Is that allowed practice to include 2 release notes in the same PR? My intuition tells me no.

@jlinder
Copy link
Collaborator Author

jlinder commented Jul 21, 2022

Hey @nickvigilante.

Ah. We missed seeing cockroachdb/docs#14376 in the initial investigation.

Yes, it's possible for multiple release notes to be present in a commit and for multiple commits in a PR to have release notes. Take a look at the General structure of a commit message section of the Git Commit Messages wiki page and the Release notes wiki page for information on how release notes work.

@nickvigilante nickvigilante changed the title docs-issue-generation: docs issues are not being created for some commits that contain release notes docs-issue-generation: docs issues are not being created for commits with multiple release notes Jul 27, 2022
@craig craig bot closed this as completed in fde7aaf Sep 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bug Code not up to spec/doc, specs & docs deemed correct. Solution expected to change code/behavior. T-dev-inf
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants