Skip to content

Commit

Permalink
Another PR for repository A-C (#36563)
Browse files Browse the repository at this point in the history
Co-authored-by: Laura Coursen <lecoursen@github.com>
  • Loading branch information
felicitymay and lecoursen authored Apr 26, 2023
1 parent 7ff486d commit de6825d
Show file tree
Hide file tree
Showing 29 changed files with 38 additions and 31 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/help/repository/archive-repository-warnings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/help/repository/artifact-drop-down-updated.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/help/repository/audit-log-entries.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/help/repository/blame-ignore-revs-file.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/help/repository/cancel-check-suite-updated.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/help/repository/changing-file-name.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/help/repository/citation-link.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/help/repository/code-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/help/repository/code-owner-for-a-file.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ versions:
{% data reusables.repositories.navigate-to-workflow %}
1. From the list of workflow runs, click the name of the `queued` or `in progress` run that you want to cancel.
1. In the upper-right corner of the workflow, click **Cancel workflow**.
![Cancel check suite button](/assets/images/help/repository/cancel-check-suite-updated.png)
![Screenshot showing the summary for a workflow that is currently running. The "Cancel workflow" button is highlighted with a dark orange outline.](/assets/images/help/repository/cancel-check-suite-updated.png)

## Steps {% data variables.product.prodname_dotcom %} takes to cancel a workflow run

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ By default, {% data variables.product.product_name %} stores build logs and arti
{% data reusables.repositories.actions-tab %}
{% data reusables.repositories.navigate-to-workflow %}
{% data reusables.repositories.view-run %}
1. Under **Artifacts**, click the artifact you want to download.
1. In the "Artifacts" section, click the artifact you want to download.

![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down-updated.png)
![Screenshot of the "Artifacts" section of a workflow run. The name of an artifact generated by the run, "artifact," is highlighted with a dark orange outline.](/assets/images/help/repository/artifact-drop-down-updated.png)


{% endwebui %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -347,8 +347,8 @@ If you are using {% data variables.product.prodname_actions %} to deploy to a cl

You can use the audit log to monitor administrative tasks in an organization. The audit log records the type of action, when it was run, and which personal account performed the action.

For example, you can use the audit log to track the `org.update_actions_secret` event, which tracks changes to organization secrets:
![Audit log entries](/assets/images/help/repository/audit-log-entries.png)
For example, you can use the audit log to track the `org.update_actions_secret` event, which tracks changes to organization secrets.
![Screenshot showing a search for "action:org.update_actions_secret" in the audit log for an organization. Two results detail API updates to two secrets that are available to selected repositories.](/assets/images/help/repository/audit-log-entries.png)

The following tables describe the {% data variables.product.prodname_actions %} events that you can find in the audit log. For more information on using the audit log, see
"[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)" and "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,6 @@ Consider combining OpenID Connect (OIDC) with reusable workflows to enforce cons

You can access information about activity related to {% data variables.product.prodname_actions %} in the audit logs for your enterprise. If your business needs require retaining this information longer than audit log data is retained, plan how you'll export and store this data outside of {% data variables.product.prodname_dotcom %}. For more information, see {% ifversion ghec %}"[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/exporting-audit-log-activity-for-your-enterprise)" and "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise)."{% else %}{% ifversion audit-log-streaming %}"[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise)" and {% endif %}"[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/log-forwarding)."{% endif %}

![Audit log entries](/assets/images/help/repository/audit-log-entries.png)

## Security

You should plan your approach to security hardening for {% data variables.product.prodname_actions %}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,9 @@ You can search for archived repositories. For more information, see "[AUTOTITLE]
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
3. Under "Danger Zone", click **Archive this repository**
![Archive this repository button](/assets/images/help/repository/archive-repository.png)
4. Read the warnings.
5. Type the name of the repository you want to archive.
![Archive repository warnings](/assets/images/help/repository/archive-repository-warnings.png)
5. In the text field, type the name of the repository you want to archive.
![Screenshot showing the "Archive repository" dialog box.](/assets/images/help/repository/archive-repository-warnings.png)
6. Click **I understand the consequences, archive this repository**.

## Unarchiving a repository
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,3 @@ If you enable the setting to always suggest updating pull request branches in yo
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
3. Under "Pull Requests", select or unselect **Always suggest updating pull request branches**.
![Checkbox to enable or disable always suggest updating branch](/assets/images/help/repository/always-suggest-updating-branches.png)
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ Anyone with admin permissions to a repository can enable or disable the automati
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
3. Under {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}"Pull Requests"{% else %}"Merge button"{% endif %}, select or unselect **Automatically delete head branches**.
![Checkbox to enable or disable automatic deletion of branches](/assets/images/help/repository/automatically-delete-branches.png)

## Further reading
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,15 @@ Lisa, M., & Bot, H. (2017). My Research Software (Version 2.0.4) [Computer softw
```
{% endraw %}

Note the example above produces a _software_ citation (i.e., `@software` type in BibTeX rather than `@article`).
Note the example above produces a _software_ citation (that is, `@software` type in BibTeX rather than `@article`).

For more information, see the [Citation File Format](https://citation-file-format.github.io/) website.

When you add a `CITATION.cff` file to the default branch of your repository, it is automatically linked from the repository landing page. This makes it easy for other users to cite your software project, using the information you've provided.
When you add a `CITATION.cff` file to the default branch of your repository, a link is automatically added to the repository landing page in the right sidebar, with the label "Cite this repository." This makes it easy for other users to cite your software project, using the information you've provided.

![Citation link on repository landing page](/assets/images/help/repository/citation-link.png)
<!-- Screenshot taken from: https://github.com/citation-file-format/ruby-cff -->

![Screenshot showing the landing page for a repository. The "Cite this repository" link in the right sidebar is highlighted with a dark orange outline and a dropdown menu with the citation details is expanded underneath.](/assets/images/help/repository/citation-link.png)

## Citing something other than software

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,13 @@ Code owners are automatically requested for review when someone opens a pull req

When someone with admin or owner permissions has enabled required reviews, they also can optionally require approval from a code owner before the author can merge a pull request in the repository. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-pull-request-reviews-before-merging)."

If a file has a code owner, you can see who the code owner is before you open a pull request. In the repository, you can browse to the file and hover over {% octicon "shield-lock" aria-label="The edit icon" %}.
If a file has a code owner, you can see who the code owner is before you open a pull request. In the repository, you can browse to the file and hover over {% octicon "shield-lock" aria-label="Owned by USER or TEAM (from CODEOWNERS line NUMBER)" %} to see a tool tip with codeownership details.

![Code owner for a file in a repository](/assets/images/help/repository/code-owner-for-a-file.png)
{% ifversion fpt or ghec %}
![Screenshot showing the header for a file. The cursor is hovering over the shield icon, which displays the tooltip "Owned by USER or TEAM (from CODEOWNERS line NUMBER)."](/assets/images/help/repository/code-owner-for-a-file.png)
{% else %}
![Screenshot showing the header for a file. The cursor is hovering over the shield icon, which displays the tooltip "Owned by USER or TEAM."](/assets/images/enterprise/repository/code-owner-for-a-file.png)
{% endif %}

## CODEOWNERS file location

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ An organization owner must allow forks of private{% ifversion ghae or ghes or gh
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
3. Under "Features", select **Allow forking**.
![Checkbox to allow or disallow forking of a private repository](/assets/images/help/repository/allow-forking-specific-org-repo.png)

## Further reading

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,9 @@ Renaming a file also gives you the opportunity to [move the file to a new locati

1. In your repository, browse to the file you want to rename.
{% data reusables.repositories.edit-file-button %}
3. In the filename field, change the name of the file to the new filename you want. You can also update the contents of your file at the same time.
![Editing a file name](/assets/images/help/repository/changing-file-name.png)
3. In the filename field, change the name of the file to the new filename you want. You can also update the contents of your file at the same time. {% ifversion fpt or ghec or ghes > 3.8 %}
![Screenshot showing a repository file open for editing in the web browser. The file name field is active and highlighted with a dark orange outline.](/assets/images/help/repository/changing-file-name.png) {% elsif ghes < 3.9 or ghae %}
![Screenshot showing a repository file open for editing in the web browser. The file name field is active and shown in the foreground.](/assets/images/enterprise/repository/changing-file-name.png) {% endif %}
{% data reusables.files.write_commit_message %}
{% data reusables.files.choose_commit_branch %}
{% data reusables.files.propose_file_change %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ You can download the source code archives in three ways.
### Downloading source code archives from the repository view

{% data reusables.repositories.navigate-to-repo %}
1. Above the list of files, click {% octicon "download" aria-label="The download icon" %} **Code**.
1. Above the list of files, click {% octicon "code" aria-hidden="true" %} **Code**.

!["Code" button](/assets/images/help/repository/code-button.png)
![Screenshot of the list of files on the landing page of a repository. The "Code" button is highlighted with a dark orange outline.](/assets/images/help/repository/code-button.png)

1. Click {% octicon "file-zip" aria-label="The ZIP icon" %} **Download ZIP**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ topics:

Code navigation helps you to read, navigate, and understand code by showing and linking definitions of a named entity corresponding to a reference to that entity, as well as references corresponding to an entity's definition.

![Code navigation display](/assets/images/help/repository/code-navigation-popover.png)
![Screenshot showing a code file with a function called "request" highlighted and a pop-up window with information about the function underneath. The pop-up has two tabs: "Definition" and "Reference".](/assets/images/help/repository/code-navigation-popover.png)

Code navigation uses the open source [`tree-sitter`](https://github.com/tree-sitter/tree-sitter) library. The following languages and navigation strategies are supported.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Within the blame view, you can view the line-by-line revision history for an ent
{% data reusables.repositories.navigate-to-repo %}
1. Click to open the file whose line history you want to view.
1. In the upper-right corner of the file view, click **Blame** to open the blame view.
![Blame button](/assets/images/help/repository/blame-button.png)
![Screenshot showing the header for a file. The "Blame" button is emphasised.](/assets/images/help/repository/blame-button.png)
1. To see earlier revisions of a specific line, or reblame, click {% octicon "versions" aria-label="View blame prior to this change" %} until you've found the changes you're interested in viewing.

![Screenshot of the "Blame" view of a file. To the right of a commit message, the versions icon is outlined in dark orange.](/assets/images/help/repository/git_blame.png)
Expand All @@ -67,7 +67,13 @@ All revisions specified in the `.git-blame-ignore-revs` file, which must be in t

Now when you visit the blame view, the listed revisions will not be included in the blame. You'll see an **Ignoring revisions in .git-blame-ignore-revs** banner indicating that some commits may be hidden:
![Screenshot of a banner on the blame view linking to the .git-blame-ignore-revs file](/assets/images/help/repository/blame-ignore-revs-file.png)
<!--Page used for the screenshots below: https://github.com/electron/electron/blame/main/lib/browser/ipc-main-internal.ts -->
{% ifversion fpt or ghec %}
![Screenshot of the blame view for the "ipc-main-internal.ts" file. A blue banner states that the information is "Ignoring revisions in .git-blame-ignore-revs." The link to the .git-blame-ignore-revs file is outlined in dark orange.](/assets/images/help/repository/blame-ignore-revs-file.png)
{% else %}
![Screenshot of the blame view for the "ipc-main-internal.ts" file. A blue banner states that the information is "Ignoring revisions in .git-blame-ignore-revs." The link to the .git-blame-ignore-revs file is outlined in dark orange.](/assets/images/enterprise/repository/blame-ignore-revs-file.png)
{% endif %}
This can be useful when a few commits make extensive changes to your code. You can use the file when running `git blame` locally as well:
Expand All @@ -85,4 +91,4 @@ git config blame.ignoreRevsFile .git-blame-ignore-revs
## Bypassing `.git-blame-ignore-revs` in the blame view
If the blame view for a file shows **Ignoring revisions in .git-blame-ignore-revs**, you can still bypass `.git-blame-ignore-revs` and see the normal blame view. In the URL, append a `~` to the SHA and the **Ignoring revisions in .git-blame-ignore-revs** will disappear.
If the blame view for a file shows **Ignoring revisions in .git-blame-ignore-revs**, you can still bypass `.git-blame-ignore-revs` and see the normal blame view. In the URL, append a `~` to the SHA and the **Ignoring revisions in .git-blame-ignore-revs** banner will disappear.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ For example, a continuous integration workflow for a Java project may run `mvn p

Now, when reviewing a pull request, you'll be able to look at the workflow run and download the artifact that was produced.

![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down-updated.png)
![Screenshot of the "Artifacts" section of a workflow run. The name of the artifact generated by the run, "artifact," is highlighted with a dark orange outline.](/assets/images/help/repository/artifact-drop-down-updated.png)

This will let you run the code in the pull request on your machine, which can help with debugging or testing the pull request.

Expand Down
4 changes: 2 additions & 2 deletions data/reusables/repositories/copy-clone-url.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
1. Above the list of files, click {% octicon "download" aria-hidden="true" %} **Code**.
!["Code" button](/assets/images/help/repository/code-button.png)
1. Above the list of files, click {% octicon "code" aria-hidden="true" %} **Code**.
![Screenshot of the list of files on the landing page of a repository. The "Code" button is highlighted with a dark orange outline.](/assets/images/help/repository/code-button.png)
1. Copy the URL for the repository.

- To clone the repository using HTTPS, under "HTTPS", click {% octicon "clippy" aria-label="Copy to clipboard" %}.
Expand Down
4 changes: 2 additions & 2 deletions data/reusables/repositories/open-with-github-desktop.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
1. Above the list of files, click {% octicon "download" aria-hidden="true" %} **Code**.
!["Code" button](/assets/images/help/repository/code-button.png)
1. Above the list of files, click {% octicon "code" aria-hidden="true" %} **Code**.
![Screenshot of the list of files on the landing page of a repository. The "Code" button is highlighted with a dark orange outline.](/assets/images/help/repository/code-button.png)
1. To clone and open the repository with {% data variables.product.prodname_desktop %}, click {% octicon "desktop-download" aria-hidden="true" %} **Open with {% data variables.product.prodname_desktop %}**.

![Screenshot of the "Code" dropdown for a repository. A button, labeled "Open with GitHub Desktop" is outlined in dark orange.](/assets/images/help/repository/open-with-desktop.png)

0 comments on commit de6825d

Please sign in to comment.