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

[improve][misc] Add IssueNavigationLink for IDEA git log #17769

Merged
merged 1 commit into from
Sep 23, 2022

Conversation

alpreu
Copy link
Contributor

@alpreu alpreu commented Sep 21, 2022

Motivation

This enables GitHub hyperlinks in IDEA for commits containing PR information.
Clicking on the link will directly open the corresponding GitHub PR.
See screenshots below:
NOW
Screenshot 2022-09-21 at 13 38 54
BEFORE
Screenshot 2022-09-21 at 13 42 06

Modifications

  • changed .gitignore
  • added vcs.xml IDEA file

Verifying this change

  • Make sure that the change passes the CI checks.

This change is a trivial rework / code cleanup without any test coverage.

Does this pull request potentially affect one of the following parts:

If the box was checked, please highlight the changes

  • Dependencies (add or upgrade a dependency)
  • The public API
  • The schema
  • The default values of configurations
  • The binary protocol
  • The REST endpoints
  • The admin CLI options
  • Anything that affects deployment

Documentation

  • doc-required
    (Your PR needs to update docs and you will update later)

  • doc-not-needed
    (Please explain why)

  • doc
    (Your PR contains doc changes)

  • doc-complete
    (Docs have been already added)

Matching PR in forked repository

PR in forked repository: alpreu#1

This enables GitHub hyperlinks in IDEA for commits containing PR information
@alpreu
Copy link
Contributor Author

alpreu commented Sep 21, 2022

As a follow-up, we could improve this even further by also linking to the corresponding WIKI page for PIPs.

This would require a change to future PIP URLs in the wiki.
Right now they are either a Github Issue URL or in the form of
https://github.com/apache/pulsar/wiki/PIP-198:-Standardize-PR-Naming-Convention-using-GitHub-Actions
To have a deterministic link all future PIPs would need to be created in the wiki and the URL would need to look like https://github.com/apache/pulsar/wiki/PIP-198
This is an entirely different discussion though.

@lhotari
Copy link
Member

lhotari commented Sep 21, 2022

Nice improvement!

@github-actions github-actions bot added the doc-not-needed Your PR changes do not impact docs label Sep 21, 2022
@heesung-sn
Copy link
Contributor

thank you for this update.

@alpreu
Copy link
Contributor Author

alpreu commented Sep 23, 2022

/pulsarbot run-failure-checks

@lhotari lhotari merged commit b03ee23 into apache:master Sep 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-not-needed Your PR changes do not impact docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants