Skip to content

Commit 03364e0

Browse files
Merge branch 'main' into fix/github-actions-major-versions
2 parents 14e65a8 + c2261db commit 03364e0

File tree

114 files changed

+363
-308
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

114 files changed

+363
-308
lines changed

.github/workflows/code-changes-comment.yml .github/workflows/comment-code-changes.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ on:
1313
# this applies to any non-content files, this workflow will run for all changed files unless it's ONLY these content-related changes
1414
paths-ignore:
1515
- 'content/**'
16-
- 'data/reusables/**'
16+
- 'data/**'
1717
- 'assets/images/**'
1818

1919
permissions:

.github/workflows/content-changes-table-comment.yml .github/workflows/comment-content-changes-table.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ on:
2727
- synchronize
2828
paths:
2929
- 'content/**'
30-
- 'data/reusables/**'
30+
- 'data/**'
3131
- 'assets/images/**'
3232

3333
permissions:
@@ -102,5 +102,5 @@ jobs:
102102
103103
---
104104
Key: **fpt**: Free, Pro, Team; **ghec**: GitHub Enterprise Cloud; **ghes**: GitHub Enterprise Server
105-
_This table is posted from the [${{ github.workflow }}](https://github.com/${{ github.repository }}/blob/${{ github.sha }}/.github/workflows/content-changes-table-comment.yml) workflow._
105+
_This table is posted from the [${{ github.workflow }}](https://github.com/${{ github.repository }}/blob/${{ github.sha }}/.github/workflows/comment-content-changes-table.yml) workflow._
106106
edit-mode: replace

.github/workflows/headless-tests.yml

+3
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,9 @@ jobs:
5151
- name: Index fixtures into the local Elasticsearch
5252
run: npm run index-test-fixtures
5353

54+
- name: Install headless browser
55+
run: npx playwright install --no-shell
56+
5457
- name: Run Playwright tests
5558
env:
5659
PLAYWRIGHT_WORKERS: ${{ fromJSON('[1, 4]')[github.repository == 'github/docs-internal'] }}

.github/workflows/local-dev.yml

+3
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@ jobs:
3434
- name: Disable Next.js telemetry
3535
run: npx next telemetry disable
3636

37+
- name: Install headless browser
38+
run: npx playwright install --no-shell
39+
3740
# The Playwright test, with the env vars we set here, takes care of
3841
# starting a server and shutting it down when it's done.
3942
# That's why it's important this step comes before the `npm start &`
Loading

content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/using-your-github-profile-to-enhance-your-resume.md

+29-32
Original file line numberDiff line numberDiff line change
@@ -24,76 +24,73 @@ Navigate to your [profile settings](https://github.com/settings/profile) to upda
2424
2525
## Step 2: Create a profile README
2626

27-
Compared to your bio, your profile README is flexible and allows for more creativity. You can write more in your profile README to showcase your skills and interests.
27+
Compared to your bio, your profile README is more flexible, allowing for more creativity. You can write more in your profile README to showcase your skills and interests.
2828

2929
Things you may want to add to your profile README include:
3030

3131
* **An introduction**: Write a brief introduction of yourself and your professional background.
32-
* **Skills and experience**: List your technical skills, including any programming languages, frameworks, and tools you are proficient in.
33-
* **Your professional experience**: Describe where you've worked before and what sort of professional skills you've built. These can even be non-technical skills, such as communication and empathy.
32+
* **Skills**: List your technical skills, including any programming languages, frameworks, and tools you are proficient in.
33+
* **Professional experience**: Describe where you've worked before and what sort of professional skills you've built. These can even be non-technical skills, such as communication and empathy.
3434
* **Some of your best projects**: Describe some projects you're proud of. You'll also pin these repositories later, but your README gives you a chance to provide more commentary.
3535
* **Achievements or awards**: Show off any of your achievements, including certifications or awards you've received for your work.
3636

37-
For instructions for creating a profile README, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme#adding-a-profile-readme).
37+
To create your profile README, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme#adding-a-profile-readme).
3838

3939
> [!NOTE] Updating and customizing your profile README also helps demonstrate fluency using Markdown and HTML, which are useful skills for technical jobs. To show off your skills for potential employers, look for ways to use more advanced Markdown or HTML elements in your profile README.
4040
4141
## Step 3: Showcase your best projects
4242

43-
Pick your favorite 3-5 projects to highlight for your job application. For the best chances at an interview, pick projects that show your diverse skills and are relevant to your specific job search.
43+
Pick 3-5 projects to highlight by "pinning" them on your profile. Repositories you pin will be prominently displayed, allowing you to direct hiring managers' attention to the projects you're most proud of.
4444

45-
These can be projects you created or projects that you contributed to:
45+
For the best chances at an interview, pick projects that show your diverse skills and are relevant to your specific job search.
4646

47-
* Projects you own are fully under your control, so you can prepare the project using the rest of the steps below.
48-
* Open source projects highlight your ability to collaborate with others.
49-
50-
To take advantage of both, pin some of each to your profile.
47+
If possible, pin some projects you created and some that you contributed to:
5148

52-
Repositories you pin will be prominently displayed on your profile, allowing you to direct hiring managers' attention to the projects you're most proud of.
49+
* Projects you own are fully under your control, so you can improve them using of the steps below.
50+
* Open source projects highlight your ability to collaborate with others.
5351

54-
To get started, click **Customize your pins** in the "Popular repositories" section of your profile.
52+
To pin the repositories, click **Customize your pins** in the "Popular repositories" section of your profile.
5553

5654
## Step 4: Improve your showcased projects
5755

5856
Hiring managers usually consider many applicants for each role. Expect that they will only look at your projects for a couple minutes. To give the best impression during this brief time, you should make your projects easy to understand and explore.
5957

60-
Below, you'll find some practical suggestions for preparing your showcase projects, as well as some tips on using {% data variables.product.prodname_copilot_short %} to help.
58+
### Write a helpful README
6159

62-
> [!NOTE] Always verify the answers that {% data variables.product.prodname_copilot_short %} provides.
60+
The README for your project's repository is a perfect space to give a concise project overview. Use [{% data variables.product.prodname_copilot_chat_short %}](https://github.com/copilot) to help write your README, with a prompt like this:
6361

64-
### Update the repository details
62+
>Write a README for my lottery-number-generator repository.
6563
66-
On the main page of the repository, to the right of "About," click {% octicon "gear" aria-label="Edit repository metadata" %}. Here, you can provide information that helps hiring managers quickly understand the project:
67-
* A brief description of your project
68-
* A website where you can see the project in action
69-
* Topic tags that categorize your project
64+
Then, copy the response into a `README.md` file in the root of the repository, editing as needed. Helpful READMEs include:
7065

71-
### Write a helpful README
72-
73-
The README for your project's repository is a perfect space to give a concise project overview. Helpful project README details include:
7466
* A list of key features of the project
7567
* Details on how to set up and run the project
7668
* An example or demo of the project
7769
* Instructions on testing your code
7870

79-
You can use [Copilot Chat](https://github.com/copilot) to help write your README. Use a prompt like this:
80-
>Write a README for my `lottery-number-generator` repository.
71+
### Update the repository details
72+
73+
On the main page of the repository, to the right of "About," click {% octicon "gear" aria-label="Edit repository metadata" %}. Here, you can provide information that helps hiring managers quickly understand the project:
74+
* A brief description of your project
75+
* A website where you can see the project in action
76+
* Topic tags that categorize your project
8177

8278
### Make the code easy to understand
8379

84-
To give the best impression, you'll want to make sure that hiring managers can understand your project quickly. In general, a few best practices can help give any readers an understanding of your project and how you work with code:
80+
To give the best impression, you'll want to make sure that hiring managers can understand your project quickly. Follow these best practices:
8581

86-
* Maintain a consistent coding style with descriptive file and directory names throughout the project
87-
* Use helpful comments and documentation for any complex or important snippets
88-
* Refine your code according to popular style guides
89-
* Simplify complex functions, break down large classes, and remove redundant code
90-
* Provide tests to validate that your code is working as expected
82+
* Maintain a **consistent coding style** throughout the project
83+
* Use **descriptive** file and directory names
84+
* Use helpful **comments and documentation** for any complex or important snippets
85+
* Refine your code according to popular **style guides**
86+
* **Simplify** complex functions, break down large classes, and remove redundant code
87+
* Provide **tests** to validate that your code is working as expected
9188

92-
It might be easiest to make these changes locally in {% data variables.product.prodname_vscode_shortname %}, using the {% data variables.product.prodname_copilot_extension_vsc %}. For example, when you start typing a line comment, {% data variables.product.prodname_copilot_short %} can automatically suggest the rest of the comment.
89+
It's easiest to make these changes in {% data variables.product.prodname_vscode_shortname %} with {% data variables.product.prodname_copilot_short %}. For example, when you start typing a line comment, {% data variables.product.prodname_copilot_short %} can automatically suggest the rest of the comment. To get started, see [Set up Visual Studio Code with Copilot](https://code.visualstudio.com/docs/copilot/setup-simplified) in the Visual Studio Code documentation.
9390

9491
### Update your project's dependencies
9592

96-
To showcase your understanding of security best practices, ensure your project is using the latest versions of any dependencies. {% data variables.product.prodname_dependabot %} can alert you to security vulnerabilities in your dependencies and generate pull requests that will update your project to the latest version. See [AUTOTITLE](/code-security/getting-started/dependabot-quickstart-guide).
93+
To showcase your understanding of security best practices, ensure your project is using the **latest versions** of any dependencies. You can automate this process with {% data variables.product.prodname_dependabot %}, which generates pull requests that update your project to the latest version. See [AUTOTITLE](/code-security/getting-started/dependabot-quickstart-guide).
9794

9895
## Extra credit: Maintaining your projects
9996

content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/unlinking-your-email-address-from-a-locked-account.md

+24-12
Original file line numberDiff line numberDiff line change
@@ -12,29 +12,41 @@ topics:
1212
shortTitle: Unlink your email
1313
---
1414

15-
> [!NOTE]
16-
> * Following these steps will not disable 2FA or provide access to a locked account, but will instead unlink the associated email address so it may be used for a different account. If you cannot regain access to the 2FA locked account, these steps will permanently break the link between the account and the linked email address. Before continuing with this article, be sure you have lost all access to your account. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials).
17-
> * If you recover access to your locked account, you can re-link an unlinked email address. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account).
18-
1915
## About unlinking your email address
2016

21-
Since an email address can only be associated with a single {% data variables.product.prodname_dotcom %} account, when you've lost your 2FA credentials and are unable to recover access, unlinking your email address from the locked account allows you to link that email address to a new or existing account. Additionally, linking a previously used commit email address to a new account will connect your commit history to that account. Unless you have chosen to keep your email address private, your account's commit email address is the same as your account's primary email address. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address). Be aware that nothing else associated with your 2FA locked account, including your repositories, permissions, and profile, will transfer to your new account.
17+
Since an email address can only be associated with a single {% data variables.product.prodname_dotcom %} account, when you've lost your 2FA credentials and are unable to recover access, unlinking your email address from the locked account allows you to link that email address to a new or existing account. Additionally, linking a previously used commit email address to a new account will connect your commit history to that account. Unless you have chosen to keep your email address private, your account's commit email address is the same as your account's primary email address. See [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address).
2218

2319
> [!NOTE]
24-
> Backup email addresses are not associated with your commits. Unlinking a backup email address and linking the email address to a different account will not connect your commit history to that account.
20+
> The {% data variables.product.github %}-provided `noreply` email address cannot be unlinked from an account. Commits authored with a `noreply` address cannot be reconnected to a different account.
21+
22+
Be aware that nothing else associated with your 2FA locked account, including your repositories, permissions, and profile, will transfer to your new account.
2523

2624
## Unlinking your email address
2725

26+
Unlinking email addresses is only available for accounts with 2FA enabled. If you do not have 2FA enabled, you can sign in and remove your email address from your account settings.
27+
28+
> [!WARNING]
29+
> Following these steps will not disable 2FA or provide access to a locked account, but will instead unlink the associated email address so it may be used for a different account. If you cannot regain access to the 2FA locked account, these steps will permanently break the link between the account and the linked email address. Before continuing with this article, be sure you have lost all access to your account. See [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials).
30+
31+
### Unlinking with your password
32+
33+
If you know your password, you can sign in with your password to unlink your email address
34+
2835
1. Navigate to [https://github.com/login](https://github.com/login).
2936
1. To prompt two-factor authentication, type your username and password, then click **Sign in**.
30-
1. Under "Unable to verify with your security key?", click **Use a recovery code or request a reset**.
31-
1. Under "Locked out?", click **Recover your account or unlink an email address**.
37+
1. Under "Having problems?", click **Use a recovery code or begin 2FA account recovery**.
38+
1. Under "Locked out?", click **Try 2FA account recovery, or unlink your account email address(es)**.
3239
1. In the modal that appears, click **I understand, get started**.
33-
1. To send an email containing a one-time password to each email address associated with your account, click **Send one-time password**.
40+
1. You may be required to verify an email address. To send an email containing a one-time password to each email address associated with your account, click **Send one-time password**.
3441
1. To verify your identity, type the one-time password from your email in the "One-time password" text field, then click **Verify email address**.
3542
{% data reusables.accounts.unlinking-email-address %}
3643

37-
> [!NOTE]
38-
> You can also link your unlinked email to an existing {% data variables.product.prodname_dotcom %} account. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account).
44+
### Unlinking without your password
45+
46+
If you do not know your account password, you can request a password reset link to unlink your email address.
47+
48+
{% data reusables.accounts.request-password-reset-link %}
3949

40-
1. Optionally, if you have any form of payment set up on the locked account, please contact us through the {% data variables.contact.contact_support_portal %} to cancel future payments. For example, you might have a paid subscription or sponsor developers through {% data variables.product.prodname_sponsors %}. If you are sponsored through {% data variables.product.prodname_sponsors %}, please mention this so that the team can help you migrate your sponsorships.
50+
1. On {% data variables.product.prodname_dotcom %}, you will be prompted for your 2FA credentials. Under "Having problems?", click **Start a 2FA recovery request or unlink your account email address(es)**.
51+
1. In the modal that appears, click **I understand, get started**.
52+
{% data reusables.accounts.unlinking-email-address %}

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-java-with-ant.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,9 @@ We recommend that you have a basic understanding of Java and the Ant framework.
9090

9191
You can use the same commands that you use locally to build and test your code.
9292

93-
The workflow template will run the default target specified in your _build.xml_ file. Your default target will commonly be set to build classes, run tests and package classes into their distributable format, for example, a JAR file.
93+
The workflow template will run the default target specified in your `build.xml` file. Your default target will commonly be set to build classes, run tests and package classes into their distributable format, for example, a JAR file.
9494

95-
If you use different commands to build your project, or you want to run a different target, you can specify those. For example, you may want to run the `jar` target that's configured in your `_build-ci.xml_` file.
95+
If you use different commands to build your project, or you want to run a different target, you can specify those. For example, you may want to run the `jar` target that's configured in your `build-ci.xml` file.
9696

9797
```yaml copy
9898
steps:

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-java-with-gradle.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ You can use the same commands that you use locally to build and test your code.
103103

104104
The workflow template will run the `build` task by default. In the default Gradle configuration, this command will download dependencies, build classes, run tests, and package classes into their distributable format, for example, a JAR file.
105105

106-
If you use different commands to build your project, or you want to use a different task, you can specify those. For example, you may want to run the `package` task that's configured in your _ci.gradle_ file.
106+
If you use different commands to build your project, or you want to use a different task, you can specify those. For example, you may want to run the `package` task that's configured in your `ci.gradle` file.
107107

108108
```yaml copy
109109
steps:

0 commit comments

Comments
 (0)