Add Task_3 by Angelarajchadha · Pull Request #1826 · github/docs · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
202 commits
Select commit Hold shift + click to select a range
b781e43
Add experimental react support within markdown
chiedo Oct 16, 2020
797adb1
Add a cool table component
chiedo Oct 18, 2020
c5a34e4
Set up foundations for code switcher
chiedo Oct 19, 2020
d264c65
Add better code block component
chiedo Oct 19, 2020
d51688b
Everything working but CodeEditor
chiedo Oct 19, 2020
35c38e5
Add CodeEditor example
chiedo Oct 19, 2020
b1fa93f
Move object hash to dependencies
chiedo Oct 19, 2020
548853f
Add some comments to explain what the code in server does
chiedo Oct 20, 2020
6e5673c
Make code a little less sloppy
chiedo Oct 20, 2020
8ef2822
Add performance optimization
chiedo Oct 20, 2020
89d745b
Remove uneeded code
chiedo Oct 20, 2020
3c71bc7
Minor patches
chiedo Oct 20, 2020
b8c8e0f
Minor performance improvement
chiedo Oct 20, 2020
7573ff2
Add some comments that explain logic
chiedo Oct 20, 2020
d818c9f
restore old hidden docs implementation
sarahs Oct 20, 2020
02308fd
add early-access-test to products.yml
sarahs Oct 20, 2020
247fa66
hide contribution button on hidden docs
sarahs Oct 20, 2020
a45c854
activeProducts are neither wip nor hidden
sarahs Oct 20, 2020
f40f241
support hidden products, which will just be early-access in practice
sarahs Oct 20, 2020
fe81204
Make the rendering engine safe
chiedo Oct 21, 2020
a48998c
Keep all the React Engine logic in one file
chiedo Oct 21, 2020
beaf733
hide early-access from public list of products
sarahs Oct 21, 2020
e44bef8
Merge branch 'main' of https://github.com/github/docs-internal into h…
sarahs Oct 21, 2020
3170d8c
try heroku prebuild script
sarahs Oct 21, 2020
f355a2e
use GITHUB_TOKEN for clone
sarahs Oct 21, 2020
71bfc0d
go back to old access key for testing
sarahs Oct 21, 2020
1a0c41b
testing testing
sarahs Oct 21, 2020
0304ff3
testing testing
sarahs Oct 21, 2020
07d090e
use early-access-test
sarahs Oct 21, 2020
d290d40
update middleware and tests around robots.txt exclusions of hidden/EA…
sarahs Oct 22, 2020
f4e05b1
exclude hidden products in addition to hidden pages from Algolia
sarahs Oct 22, 2020
4341a92
Merge branch 'main' of https://github.com/github/docs-internal into h…
sarahs Oct 22, 2020
129641c
add separate clone script to be run as heroku-prebuild script or loca…
sarahs Oct 22, 2020
d7be84f
Merge branch 'main' of https://github.com/github/docs-internal into h…
sarahs Oct 23, 2020
896db3d
comment out branch check for now
sarahs Oct 23, 2020
822649f
add yml config file for setting the EA branch
sarahs Oct 23, 2020
16f9fc7
use the new yml config file for setting the EA branch
sarahs Oct 23, 2020
ea9b161
change GITHUB_DOCUBOT_REPO_PAT to DOCUBOT_REPO_PAT
sarahs Oct 23, 2020
a36c112
test for presence of content/early-access dir
sarahs Oct 23, 2020
e94e4b7
clone early-access repo during testing
sarahs Oct 23, 2020
b020382
empty commit
sarahs Oct 23, 2020
cad55f5
set staging branch back to main
sarahs Oct 26, 2020
1e9a319
conditional test of early access in actions only
sarahs Oct 26, 2020
24a281a
run clone script from docs-internal only
sarahs Oct 26, 2020
df545e8
update var refs in script
sarahs Oct 26, 2020
dc50c74
Merge branch 'main' of https://github.com/github/docs-internal into h…
sarahs Oct 26, 2020
472a9d2
Merge branch 'main' of https://github.com/github/docs-internal into h…
sarahs Oct 26, 2020
fc33985
Merge branch 'main' into hidden-docs-alt
sarahs Oct 26, 2020
63e3f91
Merge branch 'main' of https://github.com/github/docs-internal into h…
sarahs Nov 2, 2020
271923e
Merge branch 'hidden-docs-alt' of https://github.com/github/docs-inte…
sarahs Nov 2, 2020
67466e8
duplicate change between lint and test steps
sarahs Nov 2, 2020
521d11b
Merge branch 'main' into hidden-docs-alt
JamesMGreene Nov 3, 2020
04e9656
Use Heroku postbuild so the dependencies are installed before cloning…
JamesMGreene Nov 3, 2020
9720574
Add a username to the Git repo string for more completeness
JamesMGreene Nov 3, 2020
850c11a
Fix workflow syntax error
JamesMGreene Nov 3, 2020
c6980ab
Fix the other workflow syntax error I missed
JamesMGreene Nov 3, 2020
3008ad1
Update all heroku-prebuild refs to heroku-postbuild
JamesMGreene Nov 3, 2020
3e09715
Add debugging log to cloning script
JamesMGreene Nov 3, 2020
1ea1396
Split debugging statement
JamesMGreene Nov 3, 2020
7514a54
Remove EA cloning from lint -- no JS files in there to lint
JamesMGreene Nov 3, 2020
d00f437
Remove debugging statements
JamesMGreene Nov 3, 2020
105bf42
Try removing the x-access-token username from the Git URL
JamesMGreene Nov 3, 2020
da7afd4
Manually override GitHub Actions extraHeader
JamesMGreene Nov 3, 2020
e913c26
Try ONLY clearing out the extraHeader value rather than overwriting it
JamesMGreene Nov 3, 2020
8b8d6d2
Merge branch 'main' into hidden-docs-alt
heiskr Nov 3, 2020
0cf94f2
Merge branch 'main' of https://github.com/github/docs-internal into h…
sarahs Nov 3, 2020
c4b5018
update docs path in newly added robots test
sarahs Nov 3, 2020
089e99b
Merge branch 'main' into hidden-docs-alt
sarahs Nov 4, 2020
2be96ed
Try using actions/checkout's persist-credentials input instead of man…
JamesMGreene Nov 4, 2020
4868f97
Explicitly add 'npm run build' to the 'heroku-postbuild' script as th…
JamesMGreene Nov 4, 2020
ed3baeb
Update to use new github/docs-early-access repo
JamesMGreene Nov 5, 2020
514ec66
Simplify repository element to use https URL
jcansdale Nov 6, 2020
c3616f2
Update content/packages/using-github-packages-with-your-projects-ecos…
jcansdale Nov 6, 2020
a734791
Make spacing of ":" consistent with "publishConfig"
jcansdale Nov 9, 2020
f410fd1
Mostly reverting github/docs-internal#15313
JamesMGreene Nov 9, 2020
e1f3f64
Merge branch 'main' into hidden-docs-alt
JamesMGreene Nov 9, 2020
81fda0e
Cloning script refinements and future planning
JamesMGreene Nov 9, 2020
2c030a8
Remove early-access from the sorted product ID list???
JamesMGreene Nov 10, 2020
4fac3de
Comment out premature tests
JamesMGreene Nov 10, 2020
3e0d94e
Fix pathing on CrowdIn config tests
JamesMGreene Nov 10, 2020
bdb859f
Be consistent about paths in CrowdIn config
JamesMGreene Nov 10, 2020
dbdb886
Fixes #1190
pr0PM Nov 10, 2020
bc3131b
Remove old '/early-access' redirect from API Previews page
JamesMGreene Nov 10, 2020
10b9000
Add early-access back in as a product
JamesMGreene Nov 10, 2020
6940bc3
Sort hidden page listing by relativePath
JamesMGreene Nov 10, 2020
b75cb10
Make Early Access tests only run on the docs-internal repo
JamesMGreene Nov 10, 2020
dac5bc7
Don't re-run build for Actions in the internal repo
JamesMGreene Nov 10, 2020
5b6d704
Rename clone-early-access script
JamesMGreene Nov 10, 2020
050ff6d
Update for early-access under assets/images/
JamesMGreene Nov 10, 2020
1b3af6e
Add Early Access context via middleware to show list of pages
JamesMGreene Nov 11, 2020
287ee20
EA context middleware cleanup
JamesMGreene Nov 11, 2020
fc91756
Add script to symlink to local early-access repo
JamesMGreene Nov 11, 2020
af3a7f3
Remove unused require in script
JamesMGreene Nov 13, 2020
272c472
Add new content-linting tests for Early Access
JamesMGreene Nov 13, 2020
dc36bd8
Change one old API Previews link to use a different redirect URL with…
JamesMGreene Nov 13, 2020
53910e2
Changes to handle a symlink Early Access environment
JamesMGreene Nov 13, 2020
1a732ea
Let's 404 the /early-access page outside of local rather than 403-ing
JamesMGreene Nov 13, 2020
510a0e3
Add test to verify Early Access does not show up as a product in the …
JamesMGreene Nov 13, 2020
dd02bfa
Merge main
heiskr Nov 16, 2020
bfb4a0d
Update package-lock.json
heiskr Nov 16, 2020
367685b
Update symlinking script to support unlinking
JamesMGreene Nov 17, 2020
5c6f5bb
Fix site-data-references tests by using uniqWith instead of uniqBy
JamesMGreene Nov 17, 2020
a53255c
Add tests for site-data-references within article metadata
JamesMGreene Nov 17, 2020
88a889a
Ensure early-access site-data-references are detected by the tests
JamesMGreene Nov 17, 2020
04dff85
Include other actions-only EA-cloning tests now
JamesMGreene Nov 17, 2020
890e86c
Merge branch 'main' into hidden-docs-alt
heiskr Nov 17, 2020
909db6f
Update EA cloning script to rely on the current git branch
JamesMGreene Nov 17, 2020
4962f91
Fix test workflow file
JamesMGreene Nov 17, 2020
1280f6f
Fix rendering tests for /early-access
JamesMGreene Nov 17, 2020
b04f01d
Ignore early-access as a product for the category-pages tests?
JamesMGreene Nov 17, 2020
72d1265
Fix lint-files tests for Early Access to use newly established pattern
JamesMGreene Nov 17, 2020
d402a60
Merge branch 'main' into hidden-docs-alt
JamesMGreene Nov 17, 2020
d6fcc36
Render the nice 404 page for /early-access in non-local envs
JamesMGreene Nov 18, 2020
486973a
Add missing space
dassencio Dec 1, 2020
b244d44
Merge branch 'main' of github.com:github/docs-internal into hidden-do…
sarahs Dec 1, 2020
6304c86
lint
sarahs Dec 1, 2020
93a9d3b
add new script
sarahs Dec 1, 2020
6214ee0
be careful of paths for cross-platform use
sarahs Dec 1, 2020
e49914f
render early access links for the current version on the landing page
sarahs Dec 1, 2020
5248fac
chmod a+x script/early-access/symlink-from-local-repo.js
sarahs Dec 1, 2020
7757617
move early-access link middleware to contextualizers
sarahs Dec 1, 2020
0818014
Correcting a small typo in the UUID
taz Dec 1, 2020
6d82e46
lint
sarahs Dec 2, 2020
d3d2f08
new script to update data and image paths
sarahs Dec 2, 2020
7628caa
Merge branch 'main' of github.com:github/docs-internal into hidden-do…
sarahs Dec 2, 2020
5b49fdf
do not link to early access landing page in sidebar and breadcrumbs
sarahs Dec 2, 2020
2ad6101
show link titles and sort alphabetically
sarahs Dec 2, 2020
98e567a
add message when there are no links for a version
sarahs Dec 2, 2020
3f64bb1
Merge branch 'main' of github.com:github/docs-internal into hidden-do…
sarahs Dec 2, 2020
1258092
Merge branch 'main' of github.com:github/docs-internal into hidden-do…
sarahs Dec 2, 2020
7b9ae59
update script readmes
sarahs Dec 2, 2020
f5fc721
do not show header notifications on 404 page
sarahs Dec 2, 2020
1b051af
Merge branch 'main' of github.com:github/docs-internal into hidden-do…
sarahs Dec 2, 2020
c206ec5
redeploy to staging
sarahs Dec 2, 2020
a8e0ec4
add option to run script on provided path
sarahs Dec 2, 2020
561bd33
Update access-permissions-on-github.md
heiskr Dec 2, 2020
74d43b5
Reset a few more things
heiskr Dec 2, 2020
c084360
Update index.js
heiskr Dec 2, 2020
0c3309d
Reset package.json and package-lock.json
heiskr Dec 2, 2020
07a7822
Merge branch 'main' into experiment-with-react-and-mdx
heiskr Dec 2, 2020
d830284
Readd new packages
heiskr Dec 2, 2020
84473cb
Update engine.js
heiskr Dec 2, 2020
791c7c6
Run lint
heiskr Dec 2, 2020
8731b68
Update engine.js
heiskr Dec 2, 2020
632ef6c
Update check-deps.js
heiskr Dec 2, 2020
42f6e61
fix dropdown on mobile
Arhell Dec 2, 2020
ec00f4c
repo sync
Octomerger Dec 3, 2020
04223cf
Update content/developers/overview/about-githubs-apis.md
pr0PM Dec 3, 2020
a8a43d6
Merge branch 'main' into add-missing-space
mattpollard Dec 3, 2020
0e4be76
Merge pull request #1713 from github/add-missing-space
mattpollard Dec 3, 2020
6387403
repo sync
Octomerger Dec 3, 2020
1cb3d07
repo sync
Octomerger Dec 3, 2020
aa0c4dc
Merge branch 'main' into fix-dropdown
chiedo Dec 3, 2020
d62a724
Merge pull request #1732 from Arhell/fix-dropdown
chiedo Dec 3, 2020
fb791ff
repo sync
Octomerger Dec 3, 2020
2d07086
Add documentation for using React components
chiedo Dec 3, 2020
2f10991
Merge branch 'main' of github.com:github/docs-internal into hidden-do…
sarahs Dec 3, 2020
28f9115
Merge branch 'main' into patch-2
lecoursen Dec 3, 2020
75fd006
Close unwanted pull requests (#16679)
heiskr Dec 3, 2020
c1d7d83
Merge pull request #1229 from pr0PM/patch-2
lecoursen Dec 3, 2020
f89c983
Update README.md
heiskr Dec 3, 2020
11d8e41
Check repository references (#16680)
heiskr Dec 3, 2020
92ba8d9
Merge branch 'main' into experiment-with-react-and-mdx
heiskr Dec 3, 2020
c410020
Update engine.js
heiskr Dec 3, 2020
cc4b5d6
Merge branch 'main' into repository-https
runleonarun Dec 3, 2020
82644ef
Merge branch 'main' of github.com:github/docs-internal into hidden-do…
sarahs Dec 3, 2020
1f3eadb
Merge pull request #610 from github/experiment-with-react-and-mdx
heiskr Dec 3, 2020
52301f3
add clarifying comments about how we derive data filepaths from data …
sarahs Dec 3, 2020
7c69169
Merge branch 'main' into repository-https
runleonarun Dec 3, 2020
bf61f53
lint
sarahs Dec 3, 2020
ae9956c
add slashes to data paths for consistency with other paths
sarahs Dec 3, 2020
b46e881
properly concat versioned hidden product hrefs
sarahs Dec 3, 2020
ca39999
update hidden page expectations
sarahs Dec 3, 2020
1b92a14
Missing "©" in small-footer #1744
ZainUrRehmanKhan Dec 3, 2020
0ae3d35
Merge pull request #16143 from github/hidden-docs-alt
sarahs Dec 3, 2020
c583392
add comment
sarahs Dec 3, 2020
44ccfc2
Merge pull request #16745 from github/hidden-docs-alt-followup
sarahs Dec 3, 2020
30cdb31
Allow repo sync in public repo (#16746)
heiskr Dec 3, 2020
962eedc
Merge pull request #1784 from ZainUrRehmanKhan/fix-Missing-"©"-i…
heiskr Dec 3, 2020
c7870f4
Skip EA articles test temporarily (#16748)
JamesMGreene Dec 3, 2020
218d08f
Branch was updated using the 'autoupdate branch' Actions workflow.
Octomerger Dec 3, 2020
25eeefb
repo sync
Octomerger Dec 3, 2020
c0b7195
Fix Early Access tests (#16749)
sarahs Dec 3, 2020
82b490c
repo sync
Octomerger Dec 3, 2020
a7466b6
Actions video (#16744)
JasonEtco Dec 3, 2020
ba6bf09
repo sync
Octomerger Dec 3, 2020
510d503
repo sync
Octomerger Dec 3, 2020
fb30a07
Unravel pages (the array + map object) (#16708)
JamesMGreene Dec 3, 2020
be8179c
Merge branch 'main' into repository-https
janiceilene Dec 3, 2020
db160b3
repo sync
Octomerger Dec 3, 2020
39b1dc6
Merge branch 'main' into repository-https
janiceilene Dec 3, 2020
d35ed4e
Merge pull request #1127 from github/repository-https
janiceilene Dec 3, 2020
c0d60a4
Merge branch 'main' into taz/repl-teardown-uuid-typo
janiceilene Dec 3, 2020
0244ff4
add openapi test from rest-api-operations (#16630)
rachmari Dec 3, 2020
8025d92
Secret scanning webhooks & APIs (#16608)
mchammer01 Dec 3, 2020
1953ed4
Merge pull request #1734 from github/taz/repl-teardown-uuid-typo
janiceilene Dec 3, 2020
df810ea
Branch was updated using the 'autoupdate branch' Actions workflow.
Octomerger Dec 3, 2020
be839f5
repo sync
Octomerger Dec 3, 2020
171b0a0
Update github-enterprise-service-level-agreement.md (#16706)
jaepak20 Dec 4, 2020
1280748
Branch was updated using the 'autoupdate branch' Actions workflow.
Octomerger Dec 4, 2020
f38432d
repo sync
Octomerger Dec 4, 2020
9c47a9e
repo sync
Octomerger Dec 4, 2020
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
3 changes: 0 additions & 3 deletions .env.example
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/improve-existing-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ labels:
assignees: ''
---
<!--
HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT https://github.com/github/docs-content/issues/new/choose INSTEAD.
HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD.
-->

<!--
For questions, ask in Discussions: https://github.com/github/docs/discussions

Before you file an issue read the:
Before you file an issue read the:
- Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
- Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/improve-the-site.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ assignees: ''
---

<!--
HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT https://github.com/github/docs-content/issues/new/choose INSTEAD.
HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD.
-->

<!--
For questions, ask in Discussions: https://github.com/github/docs/discussions

Before you file an issue read the:
Before you file an issue read the:
- Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
- Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md

Expand Down
39 changes: 39 additions & 0 deletions .github/workflows/close-unwanted-pull-requests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Close unwanted pull requests
on:
pull_request:
paths:
- '.github/workflows/**'
- '.github/CODEOWNERS'
- 'translations/**'
- 'assets/fonts/**'
- 'data/graphql/**'
- 'lib/graphql/**'
- 'lib/redirects/**'
- 'lib/webhooks/**'
jobs:
close_unwanted_pull_requests:
if: github.repository == 'github/docs' && github.event.pull_request.user.login != 'Octomerger'
runs-on: ubuntu-latest
steps:
- uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
with:
script: |
await github.issues.createComment({
...context.repo,
issue_number: context.payload.pull_request.number,
body:
`Thanks for contributing! We do not accept community changes to these files at this time.
- '.github/workflows/**'
- '.github/CODEOWNERS'
- 'translations/**'
- 'assets/fonts/**'
- 'data/graphql/**'
- 'lib/graphql/**'
- 'lib/redirects/**'
- 'lib/webhooks/**'`
})
await github.issues.update({
...context.repo,
issue_number: context.payload.pull_request.number,
state: 'closed'
})
2 changes: 1 addition & 1 deletion .github/workflows/sync-algolia-search-indices.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ jobs:
if: failure()
env:
SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }}
SLACK_MESSAGE: The last Algolia workflow run for ${{github.repository}} failed. See https://github.com/github/docs-internal/actions?query=workflow%3AAlgolia
SLACK_MESSAGE: The last Algolia workflow run for ${{github.repository}} failed. Search actions for `workflow:Algolia`
23 changes: 13 additions & 10 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
with:
cancel_others: 'false'
github_token: ${{ github.token }}
paths: '[".github/workflows/test.yml",".node-version", ".npmrc", "app.json", "content/**", "data/**","lib/**", "Dockerfile", "feature-flags.json", "Gemfile", "Gemfile.lock", "middleware/**", "node_modules/**","package.json", "package-lock.json", "server.js", "tests/**", "translations/**", "Procfile", "webpack.config.js"]'
paths: '[".github/workflows/test.yml", ".node-version", ".npmrc", "app.json", "content/**", "data/**","lib/**", "Dockerfile", "feature-flags.json", "Gemfile", "Gemfile.lock", "middleware/**", "node_modules/**","package.json", "package-lock.json", "server.js", "tests/**", "translations/**", "Procfile", "webpack.config.js"]'

test:
needs: see_if_should_skip
Expand All @@ -44,6 +44,9 @@ jobs:
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Check out repo
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
with:
# Enables cloning the Early Access repo later with the relevant PAT
persist-credentials: 'false'

- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Setup node
Expand All @@ -70,19 +73,19 @@ jobs:
name: Install dependencies
run: npm ci

- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Run build script
- name: Clone early access
if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' && github.repository == 'github/docs-internal' }}
run: npm run heroku-postbuild
env:
DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }}
GIT_BRANCH: ${{ github.ref }}

- name: Run build script
if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' && github.repository != 'github/docs-internal' }}
run: npm run build

- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Run tests
run: npx jest tests/${{ matrix.test-group }}/
env:
NODE_OPTIONS: '--max_old_space_size=4096'

- name: Send Slack notification if workflow fails
uses: rtCamp/action-slack-notify@e17352feaf9aee300bf0ebc1dfbf467d80438815
if: failure() && github.ref == 'early-access'
env:
SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }}
SLACK_MESSAGE: 'Tests are failing on the `early-access` branch. https://github.com/github/docs-internal/tree/early-access'
14 changes: 11 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
.algolia-cache
.DS_Store
.env
node_modules
/node_modules/
npm-debug.log
coverage
coverage/
.linkinator
broken_links.md
/assets/images/early-access
/content/early-access
/data/early-access
dist

# blc: broken link checker
blc_output.log
blc_output_internal.log
/dist/
broken_links.md
16 changes: 0 additions & 16 deletions assets/images/octicons/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +0,0 @@
## Importing Aftermarket Octicons

#### Background
Some octicons are missing from the project's current version of the `octicons` gem. Because this project is being replaced soon and updating `octicons` would require [significant changes](https://github.com/github/docs-internal/issues/6250#issuecomment-339730405), new octicons should be added manually as needed, via the following process:

#### How to add

1. Locate the missing octicon `.svg` in [primer/octions](https://github.com/primer/octicons/tree/master/lib/svg) and download it to your local `app/assets/images/octions` folder
1. Add a line to `app/assets/stylesheets/shared/_octicons.scss` for the new octicon, like so:
```apple css
.octicon-<YOUR OCTICON NAME>:before {
content: url("#{$new-octicons-path}/<YOUR OCTICON FILENAME>.svg")
}
```

You may now use the new octicon in your content as normal! :tada:
2 changes: 2 additions & 0 deletions content/actions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ changelog:
- title: Self-Hosted Runner Group Access Changes
date: '2020-10-16'
href: https://github.blog/changelog/2020-10-16-github-actions-self-hosted-runner-group-access-changes/

product_video: https://www.youtube-nocookie.com/embed/cP0I9w2coGU

redirect_from:
- /articles/automating-your-workflow-with-github-actions/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The time required to failover depends on how long it takes to manually promote t
```
- On the new primary, remove the UUIDs using `ghe-repl-teardown`. Please replace *`UUID`* with a UUID you retrieved in the previous step.
```shell
$ ghe-repl-teardown -u <em>UUNID</em>
$ ghe-repl-teardown -u <em>UUID</em>
```

### Further reading
Expand Down
2 changes: 1 addition & 1 deletion content/admin/overview/about-enterprise-accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ An enterprise account allows you to manage multiple organizations{% if enterpris

- Member access and management (organization members, outside collaborators){% if enterpriseServerVersions contains currentVersion %}
- Billing and usage ({% data variables.product.prodname_ghe_server %} instances, user licenses, {% data variables.large_files.product_name_short %} packs){% endif %}
- Security{% if enterpriseServerVersions contains currentVersion %}(single sign-on, two factor authentication)
- Security {% if enterpriseServerVersions contains currentVersion %}(single sign-on, two factor authentication)
- Requests {% if enterpriseServerVersions contains currentVersion %}and support bundle sharing {% endif %}with {% data variables.contact.enterprise_support %}{% endif %}

{% if enterpriseServerVersions contains currentVersion %}{% data reusables.enterprise-accounts.enterprise-accounts-billing %} For more information about managing your {% data variables.product.prodname_ghe_cloud %} subscription, see "[Viewing the subscription and usage for your enterprise account](/articles/viewing-the-subscription-and-usage-for-your-enterprise-account)." {% endif %}For more information about managing your {% data variables.product.product_name %} billing settings, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,9 @@ Permission | Description
`plan` | Grants access to get information about a user's GitHub plan using the "[Get a user](/rest/reference/users#get-a-user)" endpoint. Can be one of: `none` or `read`.
[`pull_requests`](/rest/reference/permissions-required-for-github-apps/#permission-on-pull-requests) | Grants access to various pull request endpoints. Can be one of: `none`, `read`, or `write`.
[`repository_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-hooks) | Grants access to the [Repository Webhooks API](/rest/reference/repos#hooks). Can be one of: `none`, `read`, or `write`.
[`repository_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-projects) | Grants access to the [Projects API](/rest/reference/projects). Can be one of: `none`, `read`, `write`, or `admin`.
[`repository_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-projects) | Grants access to the [Projects API](/rest/reference/projects). Can be one of: `none`, `read`, `write`, or `admin`.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
[`secret_scanning_alerts`](/rest/reference/permissions-required-for-github-apps/#permission-on-secret-scanning-alerts) | Grants access to the [Secret scanning API](/rest/reference/secret-scanning). Can be one of: `none`, `read`, or `write`.{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
[`security_events`](/rest/reference/permissions-required-for-github-apps/#permission-on-security-events) | Grants access to the [Code scanning API](/rest/reference/code-scanning/). Can be one of: `none`, `read`, or `write`.{% endif %}
[`single_file`](/rest/reference/permissions-required-for-github-apps/#permission-on-single-file) | Grants access to the [Contents API](/rest/reference/repos#contents). Can be one of: `none`, `read`, or `write`.
[`starring`](/rest/reference/permissions-required-for-github-apps/#permission-on-starring) | Grants access to the [Starring API](/rest/reference/activity#starring). Can be one of: `none`, `read`, or `write`.
[`statuses`](/rest/reference/permissions-required-for-github-apps/#permission-on-statuses) | Grants access to the [Statuses API](/rest/reference/repos#statuses). Can be one of: `none`, `read`, or `write`.
Expand Down
3 changes: 2 additions & 1 deletion content/developers/apps/scopes-for-oauth-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ Name | Description
&emsp;`repo:status`| Grants read/write access to public and private repository commit statuses. This scope is only necessary to grant other users or services access to private repository commit statuses *without* granting access to the code.
&emsp;`repo_deployment`| Grants access to [deployment statuses](/rest/reference/repos#deployments) for public and private repositories. This scope is only necessary to grant other users or services access to deployment statuses, *without* granting access to the code.
&emsp;`public_repo`| Limits access to public repositories. That includes read/write access to code, commit statuses, repository projects, collaborators, and deployment statuses for public repositories and organizations. Also required for starring public repositories.
&emsp;`repo:invite` | Grants accept/decline abilities for invitations to collaborate on a repository. This scope is only necessary to grant other users or services access to invites *without* granting access to the code.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest"%}
&emsp;`repo:invite` | Grants accept/decline abilities for invitations to collaborate on a repository. This scope is only necessary to grant other users or services access to invites *without* granting access to the code.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
&emsp;`security_events` | Grants: <br/> read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning). <br/> read and write access to security events in the [{% data variables.product.prodname_secret_scanning %} API](/rest/reference/secret-scanning).{% endif %}{% if currentVersion ver_gt "enterprise-server@2.21" and currentVersion ver_lt "enterprise-server@3.1" %}
&emsp;`security_events` | Grants read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning).{% endif %}
**`admin:repo_hook`** | Grants read, write, ping, and delete access to repository hooks in public and private repositories. The `repo` and `public_repo` scopes grants full access to repositories, including repository hooks. Use the `admin:repo_hook` scope to limit access to only repository hooks.
&emsp;`write:repo_hook` | Grants read, write, and ping access to hooks in public or private repositories.
Expand Down
6 changes: 1 addition & 5 deletions content/developers/overview/about-githubs-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,7 @@ versions:
github-ae: '*'
---

There are two stable versions of the GitHub API: the [REST API](/rest) and the [GraphQL API](/graphql).

When using the REST API, we encourage you to [request v3 via the `Accept` header](/rest/overview/media-types#request-specific-version).

For information on using the GraphQL API, see the [v4 docs](/graphql).
There are two stable versions of the GitHub API: the [REST API](/rest) and the [GraphQL API](/graphql). When using the REST API, we encourage you to [request v3 via the `Accept` header](/v3/media/#request-specific-version). For information on using the GraphQL API, see the [v4 docs](/graphql).

## Deprecated versions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ Also, the `User-Agent` for the requests will have the prefix `GitHub-Hookshot/`.

{{ webhookPayloadsForCurrentVersion.check_suite.completed }}

{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
### code_scanning_alert

{% data reusables.webhooks.code_scanning_alert_event_short_desc %}
Expand Down Expand Up @@ -1099,6 +1099,31 @@ Key | Type | Description

{% endif %}

{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}

### secret_scanning_alert

{% data reusables.webhooks.secret_scanning_alert_event_short_desc %}

#### Availability

- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `secret_scanning_alerts:read` permission

#### Webhook payload object

{% data reusables.webhooks.secret_scanning_alert_event_properties %}
{% data reusables.webhooks.repo_desc %}
{% data reusables.webhooks.org_desc %}
{% data reusables.webhooks.app_desc %}
`sender` | `object` | If the `action` is `resolved` or `reopened`, the `sender` object will be the user that triggered the event. The `sender` object is empty for all other actions.

#### Webhook payload example

{{ webhookPayloadsForCurrentVersion.secret_scanning_alert.reopened }}
{% endif %}

### security_advisory

Activity related to a security advisory. A security advisory provides information about security-related vulnerabilities in software on GitHub. The security advisory dataset also powers the GitHub security alerts, see "[About security alerts for vulnerable dependencies](/articles/about-security-alerts-for-vulnerable-dependencies/)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ When {% data variables.product.prodname_secret_scanning %} detects a secret in a

Repository administrators and organization owners can grant users and team access to {% data variables.product.prodname_secret_scanning %} alerts. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)."

To monitor results from {% data variables.product.prodname_secret_scanning %} across your private repositories or your organization, you can use the {% data variables.product.prodname_secret_scanning %} API. For more information about API endpoints, see "[{% data variables.product.prodname_secret_scanning_caps %}](/rest/reference/secret-scanning)."

{% data variables.product.product_name %} currently scans private repositories for secrets issued by the following service providers.

- Adafruit
Expand Down
Loading