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

Minor document update with clear images #247

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,8 @@ Login and Password to token**
> credentials.

Choose a reason for hiding this comment

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

By trial and error I found that the "Secret text" token, at least for a public github.com account, should contain just the token value ("ghp_Vari0usChars"); the "Test Connection" button helps see if that works. It seems that github knows the user name from that token alone.

I did not uncover what "in corresponding domain" here means in practice, and "Credentials are filtered on changing custom GitHub URL" in help text. My credential ID and description deliberately did not mention neither the account name nor github.com, and it still worked for the default https://api.github.com URL.

This would be nice to clarify in the doc and help, while we are at it.

Copy link
Author

@srbala srbala Jul 31, 2021

Choose a reason for hiding this comment

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

Adding some some text and screen shorts would be nice, I think.

**Step 2.2.** Select previously created "Secret Text" credentials with
GitHub OAuth token.
GitHub OAuth token. Username/Passwowrd credentials cannot be used for
auto configuration of GitHub security policy effecive since Feb 21.

*Required scopes for token*

Expand All @@ -103,10 +104,12 @@ only credentials that matched by predefined domains.
![](/docs/images/secret-text.png)

**Step 3.** Once that configuration is done, go to the project config of
each job you want triggered automatically and simply check "Build when a
change is pushed to GitHub" under "Build Triggers". With this, every new
each job you want triggered automatically and simply check "GitHub hook
trigger for GITScm polling" under "Build Triggers". With this, every new
push to the repository automatically triggers a new build.

![](/docs/images/gitscm.png)

Note that there's only one URL and it receives all post-receive POSTs
for all your repositories. The server side of this URL is smart enough
to figure out which projects need to be triggered, based on the
Expand Down
Binary file modified docs/images/changes-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/changes-old-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/changes-old.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/changes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/ghserver-config-old.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/ghserver-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/gitscm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/manage-token-old.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/manage-token.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.