Skip to content

Commit 21dfcd2

Browse files
Tciasm handshake documentation update (#3338)
* Add P4 and SVN .travis.yml instructions to Assembla section Paths to put .travis.yml in P4 and SVN repositories at Assembla * Fix direct Travis CI app links Updated multiple links to be directly referring to the Travis CI web app when instructions tell user to 'go to Travis and...' * Added references to pages clarifying access rights exercised by Travis CI with VCSes * removed travis-ci.org section as all is now under travis-ci.com * Added extended information on Assembla SVN and P4 access exercised by Travis CI * updated layout and links * moved Assembla behind GitHub * added shared build config imports link to 'further reading' section * Added 'important' to Assembla section * commas to colons * Assembla after GitHub - fix * Update assembla-oauth-scopes.md reviewed * Update tutorial.md reviewed --------- Co-authored-by: nrios14 <[email protected]>
1 parent 48c13b9 commit 21dfcd2

File tree

3 files changed

+109
-90
lines changed

3 files changed

+109
-90
lines changed

user/assembla-oauth-scopes.md

Lines changed: 38 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ permalink: /user/assembla-oauth-scopes/
55

66
---
77

8-
When you sign in to Travis CI for the first time, we ask for permissions to access
8+
When you sign in to Travis CI for the first time, we ask permission to access
99
some of your data on Assembla. Read the
1010
[Scopes for the Assembla REST API](https://api-docs.assembla.cc/)
1111
for general information about this, or pick an explanation of what data we need and why we need it.
@@ -25,33 +25,60 @@ We use scoped OAuth tokens to integrate with Assembla.
2525
## Used Scopes
2626

2727
### repository
28-
Gives the app read access to all the repositories the authorizing user has access to.
28+
It gives the app read access to all the repositories the authorizing user has access to.
2929
> This scope does not give access to a repository's pull requests.
3030
3131
### repository:admin
32-
Gives the app admin access to all the repositories the authorizing user has access to. This permission is needed to add the access key. Travis CI uses the key to read the travis.yml file content.
32+
It gives the app admin access to all the repositories the authorizing user has access to. This permission is needed to add the access key. Travis CI uses the key to read the travis.yml file content.
3333

3434

3535
### pullrequest
36-
Gives the app read access to pull requests and collaborate on them. This scope implies repository, giving read access to the pull request's destination repository.
36+
It gives the app read access to pull requests and collaborate on them. This scope implies a repository giving read access to the pull request's destination repository.
3737

3838
### email
39-
Ability to see the user's primary email address. This should make it easier to use Assembla as a login provider to apps or external applications.
39+
The ability to see the user's primary email address. This should make using Assembla as a login provider to apps or external applications easier.
4040

4141
### account
42-
Ability to see all the user's account information. Note that this does not include any ability to mutate any of the data.
42+
The ability to see all the user's account information. Note that this does not include any ability to mutate the data.
4343

4444
### team
45-
The ability to find out what teams the current user is part of. This is covered by the teams endpoint.
45+
The ability to find out what teams the current user is part of. The teams' endpoint covers this.
4646

4747
### webhook
48-
Gives access to webhooks. This scope is required for any webhook related operation.
48+
Gives access to webhooks. This scope is required for any webhook-related operation.
4949

50-
This scope gives read access to existing webhook subscriptions on all resources you can access, without needing further scopes.
51-
This means that a client can list all existing webhook subscriptions on repository foo/bar (assuming the principal user has access
52-
to this repo). The additional repository scope is not required for this.
50+
This scope gives read access to existing webhook subscriptions on all resources you can access without needing further scopes.
51+
This means a client can list all existing webhook subscriptions on repository foo/bar (assuming the principal user can access
52+
this repo). The additional repository scope is not required for this.
5353

5454
Likewise, existing webhook subscriptions for a repo's issue tracker can be retrieved without holding the issue scope.
5555
All that is required is the webhook scope.
5656

5757
However, to create a webhook for issue:created, the client will need to have both the webhook as well as issue scope.
58+
59+
## Version Control System Specific Information
60+
61+
Aside from Git Repository integration, Travis CI supports the following VCS (Version Control System) integrations with Assembla:
62+
63+
| Repository type | Supported integration | Authorization engine |
64+
| ------------------- | ------------------------------------ | ------------------------------------------------------- |
65+
| Perforce Helix Core | Streams mainline and dev depots only | Ticket-based authorization only |
66+
| SVN | Apache SVN server only | svn+ssh (implies SSH keys used) + optionally use realms |
67+
68+
### SVN
69+
70+
When enabling the Assembla SVN Repository in Travis CI, the 'write access' SSH deploy key with the title 'travis-ci.com' is
71+
added to the Assembla SVN Repository Settings. This is the current Assembla requirement for authorizing the connection.
72+
Travis CI does not require write access to your repositories. Only read access is needed to set up the connection and
73+
trigger builds in Travis CI.
74+
The svn+ssh protocol is used to obtain an SVN repository copy into the ephemerical build job environment for the time
75+
needed to execute build instructions.
76+
77+
### Perforce Helix Core (P4)
78+
79+
When enabling the Assembla P4 Repository in Travis CI, a special access group is created for this P4 repository in Assembla.
80+
You can see it in the respective 'P4 Admin' section for the enabled P4 repository. It will be named 'TravisCIAccessGroup-<guid>'
81+
and login timeout for the group will be set so the ticket-based authorization does not expire until the repository is disabled
82+
in Travis CI. The group will contain the Assembla user-enabling repository in Travis CI.
83+
This is required for the Travis CI build job to communicate with Assembla P4 and obtain a copy of the source code to the ephemerical
84+
build job environment for the time needed to execute build instructions.

user/github-oauth-scopes.md

Lines changed: 0 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -50,51 +50,3 @@ Before GitHub Apps, we used scoped OAuth tokens to integrate with GitHub. As of
5050
deployment statuses for public and private repositories and organizations.
5151

5252
We need this level of access because GitHub does not provide the `read:org` (read-only) scope for private repositories.
53-
54-
### Repositories on https://travis-ci.org
55-
56-
On <https://travis-ci.org> we ask for the following permissions:
57-
58-
- `user:email` (read-only)
59-
60-
We synchronize your email addresses so we can email you build
61-
notifications.
62-
63-
Your email address can be hidden from the GitHub profile, which also hides it from us.
64-
65-
- `read:org` (read-only)
66-
67-
When you're logged in on Travis CI, we show you all of your repositories,
68-
including the ones from any organization you're part of.
69-
70-
The GitHub API hides any organizations you're a private member of without
71-
this scope. So to make sure we show you all of your repositories, we require
72-
this scope.
73-
74-
Note that this scope allows access to the basic information about both private
75-
and public repositories, but not on any of the data or code stored in them.
76-
77-
- `repo_deployment`
78-
79-
Gives us access to the [upcoming deployments
80-
API](http://developer.github.com/v3/repos/deployments/), currently in preview mode.
81-
82-
This scope currently isn't actively used, but will be in the future.
83-
84-
- `repo:status`
85-
86-
After every build, we update the status of its commit, which is most
87-
relevant for testing pull request. This scope gives us the permission to
88-
update the commit status as the build starts and finishes.
89-
90-
- `write:repo_hook`
91-
92-
Building a new repository on Travis CI is as easy as enabling it in your
93-
profile and pushing a new commit.
94-
95-
Updating the webhook required for us to be notified from GitHub on new
96-
commits or pull requests requires this API scope. Additionally, your user
97-
needs to have admin access to the repository you want to enable.
98-
99-
Note that for open source projects, we don't have any write access to your source
100-
code or your profile.

0 commit comments

Comments
 (0)