Skip to content

[improve][doc] added instructions about how to run ci from fork - #15535

Merged
Anonymitaet merged 2 commits into
apache:masterfrom
heesung-sohn:how-to-ci-on-fork
May 12, 2022
Merged

[improve][doc] added instructions about how to run ci from fork#15535
Anonymitaet merged 2 commits into
apache:masterfrom
heesung-sohn:how-to-ci-on-fork

Conversation

@heesung-sohn

@heesung-sohn heesung-sohn commented May 10, 2022

Copy link
Copy Markdown
Contributor

Motivation

As commented here, moving this instruction, how to run Pulsar CI from fork, to the contribution page in order to make it more accessible for new contributors.

Modifications

Added instructions about how to run Pulsar CI from forked github repositories in the contribution page.

Verifying this change

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

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

If yes was chosen, please highlight the changes

  • Dependencies (does it add or upgrade a dependency): (yes / no)
  • The public API: (yes / no)
  • The schema: (yes / no / don't know)
  • The default values of configurations: (yes / no)
  • The wire protocol: (yes / no)
  • The rest endpoints: (yes / no)
  • The admin cli options: (yes / no)
  • Anything that affects deployment: (yes / no / don't know)

Documentation

Check the box below or label this PR directly.

Need to update docs?

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

  • no-need-doc
    (Please explain why)

  • doc
    (Your PR contains doc changes)

  • doc-added
    (Docs have been already added)

@heesung-sohn heesung-sohn changed the title gi[improve][doc] added instructions about how to run ci from fork [improve][doc] added instructions about how to run ci from fork May 10, 2022
@github-actions github-actions Bot added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label May 10, 2022
@heesung-sohn heesung-sohn mentioned this pull request May 10, 2022
Merged
5 tasks
momo-jun
momo-jun reviewed May 11, 2022
View reviewed changes
Comment thread site2/website/contributing.md Outdated
limit-access-to-actor: true
```
and inline composite action [implementation](https://github.com/apache/pulsar/blob/master/.github/actions/ssh-access/action.yml).
The ssh acccess is secured with the ssh key registered in Github.

@momo-jun momo-jun May 11, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
The ssh acccess is secured with the ssh key registered in Github.
The ssh access is secured with the ssh key registered in GitHub.

@Anonymitaet Anonymitaet May 11, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

+1

and "SSH, SSH key", please pay attention to the capitalization for proper nouns

@heesung-sohn heesung-sohn May 11, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

updated.

momo-jun
momo-jun reviewed May 11, 2022
View reviewed changes
Comment thread site2/website/contributing.md Outdated
and inline composite action [implementation](https://github.com/apache/pulsar/blob/master/.github/actions/ssh-access/action.yml).
The ssh acccess is secured with the ssh key registered in Github.
For example, your public keys are https://github.com/horizonzy.keys.
You will first have to register a ssh public key in GitHub for that to work.

@momo-jun momo-jun May 11, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
You will first have to register a ssh public key in GitHub for that to work.
You will first have to register an ssh public key in GitHub for that to work.

@heesung-sohn heesung-sohn May 11, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

updated.

momo-jun
momo-jun reviewed May 11, 2022
View reviewed changes
Comment thread site2/website/contributing.md Outdated
```
B.) You can also create a PR to your own fork in the GitHub UI when opening
a new PR. To do so, first click on "compare across forks" and then choose
your own fork as both the fork repository and head repository.

@momo-jun momo-jun May 11, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
your own fork as both the fork repository and head repository.
your own fork as both the forked repository and head repository.

@heesung-sohn heesung-sohn May 11, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

updated.

momo-jun
momo-jun reviewed May 11, 2022
View reviewed changes
Comment thread site2/website/contributing.md Outdated

Here's one way to sync your fork's master branch with apache/pulsar's
master branch:
Let's say if you have git remotes called "upstream" for apache/pulsar and

@momo-jun momo-jun May 11, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
Let's say if you have git remotes called "upstream" for apache/pulsar and
Let's say you have git remotes called "upstream" for apache/pulsar and

@heesung-sohn heesung-sohn May 11, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

updated.

@heesung-sohn

heesung-sohn commented May 11, 2022

Copy link
Copy Markdown
Contributor Author

Thank you for checking this PR. I resolved the above comments.

@heesung-sohn
heesung-sohn requested a review from Anonymitaet May 12, 2022 00:22
@Anonymitaet Anonymitaet added this to the 2.11.0 milestone May 12, 2022
@Anonymitaet
Anonymitaet merged commit a65babe into apache:master May 12, 2022
@lhotari

lhotari commented Jun 13, 2022

Copy link
Copy Markdown
Member

@heesung-sn @Anonymitaet It looks like these instructions have been dropped and aren't on the new website. Would it be possible to get the content to the new website too?

@lhotari lhotari mentioned this pull request Jun 13, 2022
Merged
5 tasks
@heesung-sohn heesung-sohn mentioned this pull request Jun 13, 2022
Merged
@heesung-sohn

heesung-sohn commented Jun 13, 2022

Copy link
Copy Markdown
Contributor Author

@heesung-sn @Anonymitaet It looks like these instructions have been dropped and aren't on the new website. Would it be possible to get the content to the new website too?

Raised a PR to the new website repo, apache/pulsar-site#111
@Anonymitaet could you check this by any chance?

@Anonymitaet

Anonymitaet commented Jun 14, 2022

Copy link
Copy Markdown
Member

@heesung-sn @Anonymitaet It looks like these instructions have been dropped and aren't on the new website. Would it be possible to get the content to the new website too?

Raised a PR to the new website repo, apache/pulsar-site#111 @Anonymitaet could you check this by any chance?

sure, commented in your new PR.

@momo-jun momo-jun mentioned this pull request Aug 17, 2022
Closed
@heesung-sohn
heesung-sohn deleted the how-to-ci-on-fork branch April 2, 2024 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Anonymitaet Anonymitaet Anonymitaet approved these changes
@momo-jun momo-jun momo-jun approved these changes

Assignees

@heesung-sohn heesung-sohn

Labels

doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.

Projects

None yet

Milestone

2.11.0

Development

Successfully merging this pull request may close these issues.

4 participants

@heesung-sohn @lhotari @Anonymitaet @momo-jun