TerribleDev/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update git.md

Browse Source
This commit is contained in:
Robert Wallach
2018-04-10 15:01:51 -05:00
committed by GitHub
parent bccbaa6598
commit 78842d72f3
1 changed files with 31 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
articles/projects/git.md
View File

@@ -1,48 +1,55 @@
# Git Repositories
## What
* The Stoplight Platform is built on top of git
* All Stoplight projects are a git repository
* You can use Access Tokens to access the Stoplight API, authenticate Prism in a continuous integration environment, and access the underlying git repositories for projects
* You can make this part of your git workflow, add it to scripts, or your CI/CD process
The Stoplight Platform is built on top of Git. This means that all your projects are Git repositories and that our platform benefits from all the additonal functionality provided by Git. To access the Git funtionality, you can use Access Tokens to access the Stoplight API, authenticate Prism in a continuous integration enviornment, and access the underlying Git repositories for projects.
## How
> You can make this part of your Git workflow, add it to scripts, or your CI/CD process
You can clone your projects Git repository from Stoplight.
## Who
Under the Settings section in your Stoplight account, find the “Access Tokens” section.
If you have write access to a project, you will be able to:
* Pull projects via Git
* Commit to projects via Git
* Push changes to projects via Git
If you have read access to a project, you will be able to:
* Pull your project via Git
## How to Clone Your Stoplight Git Repository
1. Under the Settings section in your Stoplight account, find the “Access Tokens” section.
![Access Tokens](https://github.com/stoplightio/docs/blob/develop/assets/images/access-tokens.png?raw=true)
You will create a token to access projects that your Stoplight account has proper permissions for. These permissions match the ones in the Stoplight UI.
2. Create a token to access projects that your Stoplight account has proper permissions for. These permissions match the ones in the Stoplight UI.
If you have write access to a project, you will be able to:
* Pull projects via git
* Commit to projects via git
* Push changes to projects via git
> You can name your token whatever you want. Once you have created the token, copy it, and only store it in a safe location. Once you close the window, you will not see it again.
If you have read access to a project, you will be able to:
* Pull your project via git
3. Store your access token as an environmental variable (recommended)
You can name your token whatever you want. Once you have created the token, copy it and only store it in a safe location. Once you close the window, you will not see it again.
For example, on Mac/Linux:
We recommend to store it as an environmental variable. For example, on Mac/Linux:
```
export STOPLIGHT_TOKEN="1234567890"
```
`export STOPLIGHT_TOKEN="1234567890"`
4. You can then `git clone` the repo, replace `{stoplight-username}`, `{username}`, and `{project-name}` with the appropriate information:
You can then `git clone` the repo, replace `{stoplight-username}`, `{username}`, and `{project-name}` with the appropriate information:
`git clone https://{stoplight-username}:$STOPLIGHT_TOKEN@git.stoplight.io/{username}/{project-name}.git`
```
git clone https://{stoplight-username}:$STOPLIGHT_TOKEN@git.stoplight.io/{username}/{project-name}.git
```
For example:
`git clone https://taylor:$STOPLIGHT_TOKEN@git.stoplight.io/taylor/test-new.git`
```
git clone https://taylor:$STOPLIGHT_TOKEN@git.stoplight.io/taylor/test-new.git
```
If it is a project from an organization and not a personal project, replace `username` with `organization-name`.
5. If the project is associated with an organization and not a personal project, replace `username` with `organization-name`
Now you can make changes to your files, commit, and push to your master branch. You can see these changes in the Stoplight UI as well as the "History of Changes."
6. Now you can make changes to your files, commit, and push to your master branch. You can see these changes in the Stoplight UI as well as the "History of Changes"
Remember: You will only see changes on the master branch in the UI at this time.
> Remember: You will only see changes on the master branch in the UI at this time.
---