-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathgithub.saas.txt
165 lines (143 loc) · 10.4 KB
/
github.saas.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
┏━━━━━━━━━━━━┓
┃ GITHUB ┃
┗━━━━━━━━━━━━┛
git instaweb #Bundled in Git, but I prefer command line
GITHUB API|CLI|WEBHOOKS|APPS
|ACTIONS ==> #See other GitHub docs
┌──────────────┐
│ FEATURES │
└──────────────┘
USER PROFILE ==> # - must be same as git user.name|email
# - private email: use [email protected]
# - can block users
# - 2-factor authentication: mobile app, SMS
# - SSH keys
ORGANIZATION ==> #Team-based ACL:
# - owners
# - admin: create|delete repos
# - write: like collaborators (see below) for given repos
# - read: like everyone (see below) for given repos
PERMISSIONS ==> # - owner: can edit, manage collaborators, changing visibility to private
# - collaborators: push, manage comments|issues|pull requests, create wiki, lock conversations
# - everyone: pull|fork, comments|issues|pull requests, edit wiki
REPOSITORY ==> # - Creating: can initialize repo (LICENSE, .gitignore, README.md)
# - GIT_URL: HTTPS, SSH (must use [email protected]), Git
# - Private repo: paid
# - Can transfer repos to other users|organizations or rename: will redirect automatically from
# former URLs
FORKING ==> # - when editing a file from another repo, automatically do it
# - should add upstream repo with git remote
GIT FUNCTIONS ==> # - git log [-- FILE]: history
# - git show COMMIT:FILE: <>
# - git show COMMIT -p --stat (with also rich editing diff): commit
# - git blame: blame
# - git checkout, branch --list: branches
# - git tag, git checkout, git archive: tags
# - git diff (can also use REPO:COMMIT and {@DATE}COMMIT): REPO/compare
ISSUES AND PULL REQUESTS ==> # - assigning to people
# - applying labels (help searching)
# - applying milestones (user stories or releases, with date due, last update, percentage
# issues|pull requests done)
# - can be closed:
# - with commit message "Closes|Fixes|Resolves [USER/REPO]#NUM"
# - when pull request is (if associated with pull request)
# - with pull request description "Closed #NUM"
# - can setup default templates with ROOT/.github/PULL_REQUEST_TEMPLATE|ISSUE_TEMPLATE.md
# - can show contributing link on issues/pull requests with ROOT/.github/CONTRIBUTING.md
PULL REQUESTS ==> # - Should add tests and update documentation
# - Compare&review: pull request from same repo
# - merged with --no-ff
# - can revert too
# - use LRBRANCH pull/ID/head:LBRANCH
# - CONTRIBUTING.md: automatically shown
# - Syntax guidelines (can use .jshintrc)
RENDERING ==> #Markdown can be used in source code previewed, issues|comments|pull requests, Gists:
# - Live preview editor
# - Additional syntax:
# - links to commit ID, issue ID, @NAME mentions (notifies user)
# - tables, strikethrough
# - code blocks, with auto syntax highlighting
# - URLs autolinking
# - Emoji
#Other: diff of images, GeoJSON, STL (3D file), CSV|TSV
#Limits: 1GB/repo, 100MB/file
OTHER FUNCTIONS ==> # - commits comments
# - Releases: like tags but also has deployment archives (different from source code) and
# release comments
# - Advanced search:
# - repos, issues, users, code
# - Explore: discover new repos, starring
# - Stats:
# - commits graphs over time
# - contributors
# - traffic (git clone, pageviews)
BADGES ==> #https://img.shields.io/github/:
# - version:
# - /tag|package-json|manifest-json/USER/REPO/TAG.svg: version
# - /release/USER/REPO[/all].svg:
# - release version
# - if "all" include pre-releases
# - /release-date[-pre]/USER/REPO.svg: release date
# - license:
# - /license/USER/REPO.svg
# - traffic:
# - /downloads[-pre]/USER/REPO/[latest|RELEASE/]total|FILE.svg
# - GitHub release downloads
# - "-pre": pre-release
# - /forks|stars|watchers|followers/REPO/USER.svg?style=social&label=Fork|Star|Watch|Follow
# - /search/USER/REPO/goto.svg: number of GitHub searches
# - activity:
# - /commits-since/USER/REPO[/TAG|BRANCH].svg: number of commits
# - /commits-activity/w|m|y/USER/REPO.svg: number of commits
# - /last-commit/USER/REPO[/TAG|BRANCH].svg: last commit date
# - /contributors/USER/REPO.svg: number of contributors
# - size:
# - /languages/code-size/USER/REPO.svg: code size
# - /repo-size/USER/REPO.svg: repo size
# - /size/USER/REPO/PATH/TO/FILE.svg: file size
# - issues/PR:
# - /issues[-pr][-closed][-raw]/USER/REPO[/ISSUE_LABEL].svg: GitHub issues
# - /issues/detail/s|title|u|label|comments|age|last-update/USER/REPORT/ISSUE_ID.svg:
# - GitHub issue state|title|author|label|comments|age|last update
# - /status/s|contexts/pulls/USER/REPO/PR_ID.svg: GitHub PR state
# - languages:
# - /languages/top/USER/REPO.svg: top language
# - /languages/count/USER/REPO.svg: number of languages
# - others:
# - /commit-status/USER/REPO/BRANCH/COMMIT_HASH.svg: whether commit is in BRANCH
NOTIFICATIONS ==> # - commits pushed on own repos
# - watching repos: releases, issues, pull requests, commits comments, create|remove branches
# - use @NAME, assigning to issue|pull request, suscribe to conversation
# - following people: starring, following, creates repo, gets new fork
# - can email, RSS
WIKI ==> # - REPO with name REPO.wiki, filename is file title, many *.md files
# - Special files: Home, _Footer, _Sidebar
GITHUB PAGES ==> # - free Hosting
# - no HTTPS
# - can use custom domain name (create a CNAME root file)
# - can be:
# - user|organization page:
# - REPO name is USER|ORG.github.io.
# - Served at http://USER|ORG.github.io
# - Uses master branch.
# - project page:
# - served at http://USER|ORG.github.io/PROJECT.
# - Uses gh-pages orphan branch (git checkout --orphan)
# - Can use ready-made HTML/CSS templates
GIST ==> # - like REPO but single file
# - can be secret (not shown on Explore, but URL still public)
┌───────────────────────────┐
│ CONTINUOUS DEPLOYMENT │
└───────────────────────────┘
GH_RELEASES_DEPLOY #Create|update GitHub release, with assets in it, with Travis (see its doc)
GH_RELEASES_DEPLOY.provider #'releases'
GH_RELEASES_DEPLOY.api_key #OAUTH_TOKEN: with [public_]repo scope
GH_RELEASES_DEPLOY.
user|password #STR. Alternative (prefer OAuth)
GH_RELEASES_DEPLOY.file #FILE[_ARR]
GH_RELEASES_DEPLOY.file_glob #BOOL (def: false). Allows globbing in GH_RELEASES_DEPLOY.file
GH_RELEASES_DEPLOY.overwrite #BOOL (def: false)
GH_RELEASES_DEPLOY.name #STR. GitHub release title
GH_RELEASES_DEPLOY.body #STR. GitHub release description
GH_RELEASES_DEPLOY.
draft|prerelease #BOOL. Flag as draft|prerelease