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

Release notes: exclude closed PRs with version labels? #45377

Closed
pcsanwald opened this issue Aug 9, 2019 · 3 comments
Closed

Release notes: exclude closed PRs with version labels? #45377

pcsanwald opened this issue Aug 9, 2019 · 3 comments
Labels
:Delivery/Build Build or test infrastructure Team:Delivery Meta label for Delivery team

Comments

@pcsanwald
Copy link
Contributor

pcsanwald commented Aug 9, 2019

The release notes generation script doesn't include filtering for PRs that are closed, as opposed to merged. This is a problem, because it means that the person generating the release notes needs to somehow check every PR to ensure it's actually merged, and not closed, or, alternatively, the release notes could contain an unmerged PR.

This means that a command like this:

docker run \
  --rm \
  -it \
  -v $HOME/.elastic/github.token:/root/.github_auth \
  -v $PWD:/elasticsearch \
  docker.elastic.co/elasticsearch-infra/dev-tools:latest \
  bash -c "/elasticsearch/dev-tools/es_release_notes.pl v7.2.0 > /elasticsearch/docs/reference/release-notes/7.2.0.asciidoc"

generates a release notes file that contains these closed, unmerged pull requests:

#41488
#38504
#40047
#41799
#43910

which were all closed, as opposed to being merged. To avoid this, we could update the script to filter by is:merged or similar. That would leave us with PRs that were closed, but did have a version label, which could be less than ideal; because those version labels are then "incorrect" if we want to use the version label as a single source of truth. Is there a reason why we don't filter by is:merged today? As an alternative solution, could we handle this in the relabel step, which could remove version labels for closed PRs?

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs

@rjernst rjernst added the Team:Docs Meta label for docs team label May 4, 2020
@jrodewig jrodewig added >docs General docs changes and removed :Docs labels Sep 16, 2021
@lockewritesdocs lockewritesdocs added :Delivery/Build Build or test infrastructure and removed Team:Docs Meta label for docs team labels Apr 27, 2022
@elasticmachine elasticmachine added the Team:Delivery Meta label for Delivery team label Apr 27, 2022
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-delivery (Team:Delivery)

@lockewritesdocs lockewritesdocs added Team:Delivery Meta label for Delivery team and removed >docs General docs changes Team:Delivery Meta label for Delivery team labels Apr 27, 2022
@pugnascotia
Copy link
Contributor

We don't use that script, we can't close this.

@pugnascotia pugnascotia closed this as not planned Won't fix, can't repro, duplicate, stale Apr 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Delivery/Build Build or test infrastructure Team:Delivery Meta label for Delivery team
Projects
None yet
Development

No branches or pull requests

7 participants