Skip to content

Commit

Permalink
Merge branch 'main' into flatten-skip-duplicate-jobs
Browse files Browse the repository at this point in the history
  • Loading branch information
chiedo authored Nov 9, 2020
2 parents d9d1736 + 5cf26cc commit 5e72aa1
Show file tree
Hide file tree
Showing 15 changed files with 99 additions and 23 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,16 @@ In addition to all of the benefits of {% data variables.contact.enterprise_suppo
- Written support through our support portal 24 hours per day, 7 days per week
- Phone support 24 hours per day, 7 days per week
- A{% if currentVersion == "github-ae@latest" %}n enhanced{% endif %} Service Level Agreement (SLA) {% if enterpriseServerVersions contains currentVersion %}with guaranteed initial response times{% endif %}
- Access to premium content{% if enterpriseServerVersions contains currentVersion %}
- Scheduled health checks{% endif %}
- Managed services
{% if currentVersion == "github-ae@latest" %}
- An assigned Technical Service Account Manager
- Quarterly support reviews
- Managed Admin services
{% else if enterpriseServerVersions contains currentVersion %}
- Technical account managers
- Access to premium content
- Scheduled health checks
- Managed Admin hours
{% endif %}

{% data reusables.support.government-response-times-may-vary %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ versions:

### About {% data variables.product.prodname_actions %} permissions for your enterprise

When you enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, it is enabled for all organizations in your enterprise. You can choose to disable {% data variables.product.prodname_actions %} for all organizations in your enterprise, or only allow specific organizations. You can also limit the use of public actions, so that people can only use local actions that exist in an organization.
When you enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, it is enabled for all organizations in your enterprise. You can choose to disable {% data variables.product.prodname_actions %} for all organizations in your enterprise, or only allow specific organizations. You can also limit the use of public actions, so that people can only use local actions that exist in your enterprise.

### Managing {% data variables.product.prodname_actions %} permissions for your enterprise

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ versions:

The {% data variables.product.prodname_dependabot %} configuration file, *dependabot.yml*, uses YAML syntax. If you're new to YAML and want to learn more, see "[Learn YAML in five minutes](https://www.codeproject.com/Articles/1214409/Learn-YAML-in-five-minutes)."

You must store this file in the `.github` directory of your repository. When you add or update the *dependabot.yml* file, this triggers an immediate check for version updates. Any options that also affect security updates are used the next time a security alert triggers a pull request with for security update. For more information, see "[Enabling and disabling version updates](/github/administering-a-repository/enabling-and-disabling-version-updates)" and "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)."
You must store this file in the `.github` directory of your repository. When you add or update the *dependabot.yml* file, this triggers an immediate check for version updates. Any options that also affect security updates are used the next time a security alert triggers a pull request for a security update. For more information, see "[Enabling and disabling version updates](/github/administering-a-repository/enabling-and-disabling-version-updates)" and "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)."

### Configuration options for *dependabot.yml*

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ You can disable all workflows for a repository or set a policy that configures w
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
{% data reusables.repositories.settings-sidebar-actions %}
1. Under **Actions permissions**, select **Allow specific actions** and add your required actions to the list.
1. Under **Actions permissions**, select **Allow select actions** and add your required actions to the list.
![Add actions to allow list](/assets/images/help/repository/actions-policy-allow-list.png)
2. Click **Save**.
{% endif %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ You can disable all workflows for an organization or set a policy that configure
{% data reusables.profile.access_org %}
{% data reusables.organizations.org_settings %}
{% data reusables.organizations.settings-sidebar-actions %}
1. Under **Policies**, select **Allow specific actions** and add your required actions to the list.
1. Under **Policies**, select **Allow select actions** and add your required actions to the list.
![Add actions to allow list](/assets/images/help/organizations/actions-policy-allow-list.png)
1. Click **Save**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ You can disable all workflows for an enterprise or set a policy that configures
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.policies-tab %}
{% data reusables.enterprise-accounts.actions-tab %}
1. Under **Policies**, select **Allow specific actions** and add your required actions to the list.
1. Under **Policies**, select **Allow select actions** and add your required actions to the list.
![Add actions to allow list](/assets/images/help/organizations/enterprise-actions-policy-allow-list.png)

### Enabling workflows for private repository forks
Expand Down
2 changes: 2 additions & 0 deletions content/rest/reference/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ The Artifacts API allows you to download, delete, and retrieve information about
{% if operation.subcategory == 'artifacts' %}{% include rest_operation %}{% endif %}
{% endfor %}

{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
## Permissions

The Permissions API allows you to set permissions for what organizations and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions are allowed to run. For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#disabling-or-limiting-github-actions-for-your-repository-or-organization)."
Expand All @@ -33,6 +34,7 @@ You can also set permissions for an enterprise. For more information, see the "[
{% for operation in currentRestOperations %}
{% if operation.subcategory == 'permissions' %}{% include rest_operation %}{% endif %}
{% endfor %}
{% endif %}

## Secrets

Expand Down
19 changes: 13 additions & 6 deletions data/glossaries/external.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@
- term: branch
description: >-
A branch is a parallel version of a repository. It is contained within the
repository, but does not affect the primary or master branch allowing you to
repository, but does not affect the primary or main branch allowing you to
work freely without disrupting the "live" version. When you've made the
changes you want to make, you can merge your branch back into the master
changes you want to make, you can merge your branch back into the main
branch to publish your changes.
- term: branch restriction
description: >-
Expand Down Expand Up @@ -141,8 +141,9 @@
Short, descriptive text that accompanys a commit and communicates the change
the commit is introducing.
- term: compare branch
description: The branch you use to create a pull request.
This branch is compared to the base branch you choose for the pull request, and the changes are identified.
description: >-
The branch you use to create a pull request.
This branch is compared to the base branch you choose for the pull request, and the changes are identified.
When the pull request is merged, the base branch is updated with the changes from the compare branch.
Also known as the "head branch" of the pull request.
- term: continuous integration
Expand Down Expand Up @@ -395,12 +396,18 @@
Markdown and uses a particular form of Markdown called GitHub Flavored Markdown. See [GitHub Flavored Markdown Spec](https://github.github.com/gfm/) or [Getting started with writing and formatting on GitHub](/articles/getting-started-with-writing-and-formatting-on-github).
- term: Markup
description: A system for annotating and formatting a document.
- term: master
- term: main
description: >-
The default development branch. Whenever you create a Git repository, a
branch named "master" is created, and becomes the active branch. In most
branch named "main" is created, and becomes the active branch. In most
cases, this contains the local development, though that is purely by
convention and is not required.
- term: master
description: >-
The default branch in many Git repositories. By default, when you create
a new Git repository on the command line a branch called `master` is created.
Many tools now use an alternative name for the default branch. For example,
when you create a new repository on GitHub the default branch is called `main`.
- term: Members graph
description: A repository graph that shows all the forks of a repository.
- term: mention
Expand Down
2 changes: 1 addition & 1 deletion data/reusables/actions/actions-use-policy-settings.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
If you choose the option to **Allow specific actions**, there are additional options that you can configure. For more information, see "[Allowing specific actions to run](#allowing-specific-actions-to-run)."
If you choose **Allow select actions**, local actions are allowed, and there are additional options for allowing other specific actions. For more information, see "[Allowing specific actions to run](#allowing-specific-actions-to-run)."

When you allow local actions only, the policy blocks all access to actions authored by {% data variables.product.prodname_dotcom %}. For example, the [`actions/checkout`](https://github.com/actions/checkout) would not be accessible.
2 changes: 1 addition & 1 deletion data/reusables/actions/allow-specific-actions-intro.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
When you select the **Allow select actions**, there are additional options that you need to choose to configure the allowed actions:
When you choose **Allow select actions**, local actions are allowed, and there are additional options for allowing other specific actions:

- **Allow actions created by {% data variables.product.prodname_dotcom %}:** You can allow all actions created by {% data variables.product.prodname_dotcom %} to be used by workflows. Actions created by {% data variables.product.prodname_dotcom %} are located in the `actions` and `github` organization. For more information, see the [`actions`](https://github.com/actions) and [`github`](https://github.com/github) organizations.
- **Allow Marketplace actions by verified creators:** You can allow all {% data variables.product.prodname_marketplace %} actions created by verified creators to be used by workflows. When GitHub has verified the creator of the action as a partner organization, the {% octicon "verified" aria-label="The verified badge" %} badge is displayed next to the action in {% data variables.product.prodname_marketplace %}.
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
When you enable local actions only, workflows can only run actions located in your repository or organization.
When you enable local actions only, workflows can only run actions located in your repository, organization, or enterprise.
2 changes: 1 addition & 1 deletion data/reusables/support/ghae-priorities.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
| :---: | --- | --- |
| {% data variables.product.support_ticket_priority_urgent %} - Sev A | {% data variables.product.product_name %} is inaccessible or failing entirely, and the failure directly impacts the operation of your business.<br/><br/>_After you file a support ticket, reach out to {% data variables.contact.github_support %} via phone._ | <ul><li>Errors or outages that affect core Git or web application functionality for all users</li><li>Severe network or performance degradation for majority of users</li><li>Full or rapidly filling storage</li><li>Known security incidents or a breach of access</li></ul> |
| {% data variables.product.support_ticket_priority_high %} - Sev B | {% data variables.product.product_name %} is failing in a production environment, with limited impact to your business processes, or only affecting certain customers. | <ul><li>Performance degradation that reduces productivity for many users</li><li>Reduced redundancy concerns from failures or service degradation</li><li>Production-impacting bugs or errors</li><li>{% data variables.product.product_name %} configuraton security concerns</li></ul> |
| {% data variables.product.support_ticket_priority_normal %} - Sev C | {% data variables.product.product_name %} is experiencing limited or moderate issues and errors with {% data variables.product.product_name %}, or you have general concerns or questions about the operation of {% data variables.product.product_name %}. | <ul><li>Problems in a test or staging environment</li><li>Advice on using {% data variables.product.prodname_dotcom %} APIs and features, or questions about integrating business workflows</li><li>Issues with user tools and data collection methods</li><li>Upgrades</li><li>Bug reports, general security questions, or other feature related questions</li> |
| {% data variables.product.support_ticket_priority_normal %} - Sev C | {% data variables.product.product_name %} is experiencing limited or moderate issues and errors with {% data variables.product.product_name %}, or you have general concerns or questions about the operation of {% data variables.product.product_name %}. | <ul><li>Advice on using {% data variables.product.prodname_dotcom %} APIs and features, or questions about integrating business workflows</li><li>Issues with user tools and data collection methods</li><li>Upgrades</li><li>Bug reports, general security questions, or other feature related questions</li> |
| {% data variables.product.support_ticket_priority_low %} - Sev D| {% data variables.product.product_name %} is functioning as expected, however, you have a question or suggestion about {% data variables.product.product_name %} that is not time-sensitive, or does not otherwise block the productivity of your team. | <ul><li>Feature requests and product feedback</li><li>General questions on overall configuration or use of {% data variables.product.product_name %}</li><li>Notifying {% data variables.contact.github_support %} of any planned changes</li></ul> |
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"@github-docs/data-directory": "^1.2.0",
"@github-docs/frontmatter": "^1.3.1",
"@github-docs/render-content": "^5.2.0",
"@github/rest-api-operations": "^3.6.1",
"@github/rest-api-operations": "^3.6.2",
"@octokit/rest": "^16.38.1",
"@primer/css": "^15.1.0",
"@primer/octicons": "^11.0.0",
Expand Down
60 changes: 60 additions & 0 deletions script/create-webhooks-for-new-version.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
#!/usr/bin/env node

const fs = require('fs')
const mkdirp = require('mkdirp').sync
const path = require('path')
const program = require('commander')
const allVersions = require('../lib/all-versions')

// [start-readme]
//
// This script creates new static webhook payload files for a new version.
//
// [end-readme]

program
.description('Create new payload files in lib/webhooks/static/<new_version> based on an existing version.')
.option('-n, --newVersion <version>', 'The version to copy the payloads to. Must be in <plan@release> format.')
.option('-o, --oldVersion <version>', 'The version to copy the payloads from. Must be in <plan@release> format.')
.parse(process.argv)

if (!(program.newVersion && program.oldVersion)) {
console.log('Error! You must provide --newVersion and --oldVersion.')
process.exit(1)
}

if (!(Object.keys(allVersions).includes(program.newVersion) && Object.keys(allVersions).includes(program.oldVersion))) {
console.log('Error! You must provide the full name of a supported version, e.g., [email protected].')
process.exit(1)
}

const newVersionDirName = allVersions[program.newVersion].miscVersionName
const oldVersionDirName = allVersions[program.oldVersion].miscVersionName

const payloadsDir = 'lib/webhooks/static'
const srcDir = path.join(payloadsDir, oldVersionDirName)
const destDir = path.join(payloadsDir, newVersionDirName)

// create the new directory
mkdirp(destDir)

// copy the files
fs.readdirSync(srcDir).forEach(file => {
const srcFile = path.join(srcDir, file)
const destFile = path.join(destDir, file)
fs.copyFileSync(srcFile, destFile)
})

// check that it worked
if (!fs.existsSync(destDir)) {
console.log(`Error! A new directory was not successfully created at ${destDir}.`)
process.exit(1)
}

if (!fs.readdirSync(destDir).length) {
console.log(`Error! The directory created at ${destDir} is empty.`)
process.exit(1)
}

// print success message
console.log(`Done! Copied ${srcDir} to ${destDir}.`)

0 comments on commit 5e72aa1

Please sign in to comment.