content
large_stringlengths
3
20.5k
url
large_stringlengths
54
193
branch
large_stringclasses
4 values
source
large_stringclasses
42 values
embeddings
listlengths
384
384
score
float64
-0.21
0.65
## Overview If your organization is owned by an enterprise account, you can share actions and reusable workflows within your enterprise, without publishing them publicly, by allowing {% data variables.product.prodname\_actions %} workflows to access an internal or private repository that contains the action or reusable...
https://github.com/github/docs/blob/main//content/actions/how-tos/reuse-automations/share-with-your-enterprise.md
main
github-actions
[ -0.0653415396809578, -0.0714145079255104, -0.10385026782751083, 0.0005955437663942575, 0.016959629952907562, 0.05863440781831741, 0.06972675770521164, -0.007645894773304462, 0.018844353035092354, -0.0017958430107682943, 0.023173045367002487, 0.04098976403474808, 0.011082387529313564, -0.00...
0.158519
> [!WARNING] > \* {% data reusables.actions.outside-collaborators-actions %} > \* {% data reusables.actions.scoped-token-note %} ## Sharing actions and workflows with your organization 1. Store the action or reusable workflow in a private repository. For more information, see [AUTOTITLE](/repositories/creating-and-mana...
https://github.com/github/docs/blob/main//content/actions/how-tos/reuse-automations/share-with-your-organization.md
main
github-actions
[ -0.07553040981292725, -0.03503894433379173, -0.07348974794149399, 0.04111946001648903, 0.011794153600931168, 0.08161908388137817, 0.10018360614776611, -0.016601894050836563, -0.04093972221016884, 0.02100147120654583, 0.047741908580064774, -0.019579436630010605, 0.016407325863838196, -0.045...
0.111494
## Creating a reusable workflow Reusable workflows are YAML-formatted files, very similar to any other workflow file. As with other workflow files, you locate reusable workflows in the `.github/workflows` directory of a repository. Subdirectories of the `workflows` directory are not supported. {% ifversion ghec or ghes...
https://github.com/github/docs/blob/main//content/actions/how-tos/reuse-automations/reuse-workflows.md
main
github-actions
[ -0.023958666250109673, -0.06659288704395294, -0.03808062523603439, 0.046200599521398544, 0.023337846621870995, -0.01668010838329792, -0.037483274936676025, -0.02489703707396984, 0.04125786945223808, -0.05220052972435951, -0.037457242608070374, 0.06600794941186905, -0.0052337865345180035, -...
0.137945
main jobs: call-workflow: uses: octo-org/example-repo/.github/workflows/workflow-A.yml@v1 call-workflow-passing-data: permissions: contents: read pull-requests: write uses: octo-org/example-repo/.github/workflows/workflow-B.yml@main with: config-path: .github/labeler.yml secrets: token: ${{ secrets.GITHUB\_TOKEN }} ```...
https://github.com/github/docs/blob/main//content/actions/how-tos/reuse-automations/reuse-workflows.md
main
github-actions
[ -0.08692119270563126, -0.04616818204522133, -0.12070939689874649, 0.023711690679192543, -0.026689039543271065, -0.027855167165398598, 0.019510578364133835, -0.02756447158753872, -0.0018131451215595007, -0.06946945935487747, -0.000956604431848973, 0.04896943271160126, -0.0023054522462189198, ...
0.150662
completing reusable workflow of the matrix which actually sets a value. That means if the last successful completing reusable workflow sets an empty string for its output, and the second last successful completing reusable workflow sets an actual value for its output, the output will contain the value of the second las...
https://github.com/github/docs/blob/main//content/actions/how-tos/reuse-automations/reuse-workflows.md
main
github-actions
[ -0.07066026329994202, -0.0008434628834947944, -0.06731031090021133, 0.03461632877588272, -0.07040014863014221, 0.009137541987001896, 0.0173567496240139, -0.04965522885322571, 0.025387458503246307, -0.05878107622265816, 0.009468463249504566, -0.015076548792421818, 0.03665217384696007, -0.05...
0.053111
items in the array are in the reverse order that they were called in. For example, in a chain of workflows A > B > C, when viewing the logs for a job in workflow C, the array would be `["octo-org/octo-repo/.github/workflows/B.yml", "octo-org/octo-repo/.github/workflows/A.yml"]`. \* `calling\_workflow\_shas` - an array ...
https://github.com/github/docs/blob/main//content/actions/how-tos/reuse-automations/reuse-workflows.md
main
github-actions
[ -0.05158626288175583, 0.029446544125676155, -0.05443808436393738, -0.01735975407063961, 0.018682552501559258, -0.06428039819002151, 0.058902449905872345, -0.09219489246606827, 0.11931253969669342, -0.05243297293782234, -0.030754035338759422, 0.06639835238456726, -0.014139250852167606, -0.0...
0.146874
When a job's `if` condition is evaluated, {% data variables.product.prodname\_actions %} logs the expression evaluation to help you understand the result. This is useful for debugging both why a job was skipped and why a job ran when you expected it to be skipped. ## Accessing expression logs 1. Navigate to the workflo...
https://github.com/github/docs/blob/main//content/actions/how-tos/monitor-workflows/view-job-condition-logs.md
main
github-actions
[ -0.06470818817615509, 0.05326947197318077, -0.0438695102930069, 0.04122171178460121, 0.07509277015924454, -0.058573417365550995, 0.06378282606601715, -0.04567693546414375, 0.025526592507958412, -0.019998595118522644, 0.06403301656246185, -0.027972960844635963, 0.01188557967543602, -0.06986...
0.061914
{% data reusables.actions.enterprise-github-hosted-runners %} You can see whether a workflow run is in progress or complete from the workflow run page. You must be logged in to a {% data variables.product.prodname\_dotcom %} account to view workflow run information, including for public repositories. For more informati...
https://github.com/github/docs/blob/main//content/actions/how-tos/monitor-workflows/use-workflow-run-logs.md
main
github-actions
[ 0.009843803010880947, -0.051615696400403976, -0.07648597657680511, 0.015005174092948437, 0.07551837712526321, -0.04821666702628136, -0.0011035094503313303, -0.005191138479858637, -0.003813548246398568, -0.008109519258141518, -0.027001885697245598, 0.02801322750747204, -0.006000474561005831, ...
0.103149
the previous run attempts that ran the other jobs. ## Deleting logs You can delete the log files from your workflow runs through the {% data variables.product.prodname\_dotcom %} web interface or programmatically. {% data reusables.repositories.permissions-statement-write %} ### Deleting logs via the {% data variables....
https://github.com/github/docs/blob/main//content/actions/how-tos/monitor-workflows/use-workflow-run-logs.md
main
github-actions
[ -0.05164933577179909, -0.03825691342353821, -0.018943365663290024, 0.012184377759695053, 0.036283936351537704, -0.050813641399145126, 0.029441500082612038, -0.09014110267162323, -0.04772801697254181, 0.0018331902101635933, -0.010523702017962933, 0.022483723238110542, -0.025896945968270302, ...
0.078584
that contain the word `error`. ```shell gh run view --job JOB\_ID --log | grep error ``` To filter the logs for any failed steps, use `--log-failed` instead of `--log`. ```shell gh run view --job JOB\_ID --log-failed ```
https://github.com/github/docs/blob/main//content/actions/how-tos/monitor-workflows/use-workflow-run-logs.md
main
github-actions
[ 0.0054609584622085094, 0.0162068922072649, -0.01066685002297163, -0.02564830891788006, 0.06263282895088196, -0.026769287884235382, 0.04493572935461998, -0.025168118998408318, -0.05043179169297218, 0.0021262196823954582, 0.002030008239671588, -0.10416229814291, 0.01935097761452198, 0.023033...
-0.008622
{% data reusables.actions.enterprise-github-hosted-runners %} > [!NOTE] > Workflow badges in a private repository are not accessible externally, so you won't be able to embed them or link to them from an external site. {% data reusables.repositories.actions-workflow-status-badge-intro %} To add a workflow status badge ...
https://github.com/github/docs/blob/main//content/actions/how-tos/monitor-workflows/add-a-status-badge.md
main
github-actions
[ -0.038791634142398834, 0.04138527065515518, -0.06451122462749481, 0.060423582792282104, 0.05482937768101692, 0.04449174553155899, -0.03722885251045227, 0.031102914363145828, -0.0072602033615112305, -0.015519795939326286, -0.04886813834309578, 0.08789531886577606, 0.07854153215885162, -0.00...
0.077376
{% data reusables.actions.enterprise-github-hosted-runners %} Billable job execution minutes are only shown for jobs run on private repositories that use {% data variables.product.prodname\_dotcom %}-hosted runners and are rounded up to the next minute. There are no billable minutes when using {% data variables.product...
https://github.com/github/docs/blob/main//content/actions/how-tos/monitor-workflows/view-job-execution-time.md
main
github-actions
[ -0.0072166575118899345, -0.017827069386839867, -0.07293672859668732, 0.07877255231142044, 0.032708872109651566, -0.005640807095915079, -0.020278511568903923, -0.00032377225579693913, -0.013081610202789307, 0.019869262352585793, 0.008265739306807518, 0.005480313673615456, -0.04140772670507431...
0.078786
{% data reusables.actions.enterprise-github-hosted-runners %} These extra logs are enabled by setting secrets or variables in the repository containing the workflow, so the same permissions requirements will apply: \* {% data reusables.actions.permissions-statement-secrets-variables-repository %} \* {% data reusables.a...
https://github.com/github/docs/blob/main//content/actions/how-tos/monitor-workflows/enable-debug-logging.md
main
github-actions
[ -0.001528189517557621, -0.04393333941698074, -0.05854716897010803, 0.062391024082899094, 0.055762551724910736, -0.015715792775154114, 0.011196833103895187, -0.03600405901670456, -0.025064796209335327, -0.004675221163779497, 0.0034058631863445044, 0.04022097960114479, 0.002150741871446371, ...
0.127071
{% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.repositories.permissions-statement-read %} {% webui %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %} {% data reusables.repositories.navigate-to-workflow %} {% data reusables.repositories.vi...
https://github.com/github/docs/blob/main//content/actions/how-tos/monitor-workflows/view-workflow-run-history.md
main
github-actions
[ 0.008608276955783367, -0.06784946471452713, -0.04253440350294113, 0.027856409549713135, 0.024045350030064583, -0.048788320273160934, 0.022391820326447487, -0.030481429770588875, -0.05361390858888626, -0.006653566844761372, -0.00373975932598114, 0.02642633579671383, 0.010924657806754112, -0...
0.057815
{% data reusables.actions.enterprise-github-hosted-runners %} ## Introduction After you create an action, you'll want to continue releasing new features while working with community contributions. This tutorial describes an example process you can follow to release and maintain actions in open source. The example: \* L...
https://github.com/github/docs/blob/main//content/actions/how-tos/create-and-publish-actions/release-and-maintain-actions.md
main
github-actions
[ -0.0677424743771553, -0.06647808849811554, -0.06722849607467651, 0.04305952042341232, 0.05840503051877022, 0.027025798335671425, 0.032709747552871704, 0.08838936686515808, -0.056071896106004715, 0.017151663079857826, 0.03861808031797409, 0.02314373292028904, -0.002500203438103199, -0.02425...
0.176007
your tests or other workflows triggered upon pull request require access to secrets, consider using a different event like a [manual trigger](/actions/using-workflows/events-that-trigger-workflows#manual-events) or a [`pull\_request\_target`](/actions/using-workflows/events-that-trigger-workflows#pull\_request\_target)...
https://github.com/github/docs/blob/main//content/actions/how-tos/create-and-publish-actions/release-and-maintain-actions.md
main
github-actions
[ -0.028994066640734673, -0.03219299018383026, -0.054630640894174576, -0.03214866667985916, 0.014630123041570187, -0.006646099500358105, 0.014498020522296429, 0.03495999798178673, -0.02675122767686844, 0.010933737270534039, 0.05618160218000412, -0.03773798048496246, -0.021195674315094948, -0...
0.03428
{% data reusables.actions.enterprise-github-hosted-runners %} ## About exit codes {% data variables.product.prodname\_dotcom %} uses the exit code to set the action's check run status, which can be `success` or `failure`. Exit status | Check run status | Description ------------|------------------|------------ `0` | `s...
https://github.com/github/docs/blob/main//content/actions/how-tos/create-and-publish-actions/set-exit-codes.md
main
github-actions
[ -0.040766697376966476, -0.04537731036543846, -0.083894282579422, 0.015726745128631592, 0.05301321670413017, -0.0005725238006561995, 0.056943390518426895, 0.04267556220293045, -0.018337126821279526, 0.056700222194194794, 0.06551207602024078, 0.043374720960855484, 0.024909481406211853, -0.06...
0.183181
If you enable immutable releases on your action's repository, you can manage your action's releases as follows: 1. To start the release cycle, develop and validate a potential release for your action on a release branch. 1. Determine how you want to share your changes: \* If you are ready to share an unchangeable versi...
https://github.com/github/docs/blob/main//content/actions/how-tos/create-and-publish-actions/using-immutable-releases-and-tags-to-manage-your-actions-releases.md
main
github-actions
[ -0.004771333187818527, -0.07762005180120468, -0.027026472613215446, -0.02268964610993862, 0.010558835230767727, 0.038310445845127106, 0.014505812898278236, 0.02043052949011326, -0.023136543110013008, 0.050743307918310165, 0.07895125448703766, 0.06518443673849106, 0.007395189255475998, 0.00...
0.000674
## Prerequisites >[!NOTE] > You must accept the terms of service to publish actions in {% data variables.product.prodname\_marketplace %}. Before you can publish an action, you'll need to create an action in your repository. For more information, see [AUTOTITLE](/actions/creating-actions). When you plan to publish your...
https://github.com/github/docs/blob/main//content/actions/how-tos/create-and-publish-actions/publish-in-github-marketplace.md
main
github-actions
[ -0.038273416459560394, -0.04330391064286232, -0.10535354167222977, 0.01374517660588026, -0.01854342222213745, 0.03209983557462692, 0.08034713566303253, 0.06561704725027084, -0.1204114630818367, 0.09552954882383347, 0.08442177623510361, -0.03850938379764557, 0.03570556640625, 0.017353996634...
0.045606
the title field, type a release title. 1. Complete all other fields and click \*\*Publish release\*\*. Publishing requires you to use two-factor authentication. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication). ## Remov...
https://github.com/github/docs/blob/main//content/actions/how-tos/create-and-publish-actions/publish-in-github-marketplace.md
main
github-actions
[ 0.029308825731277466, 0.030956750735640526, -0.038791172206401825, 0.044358719140291214, -0.003067734884098172, 0.03886812552809715, 0.07081317156553268, -0.03199974074959755, -0.08586739003658295, 0.10850400477647781, 0.07548519223928452, -0.01473415456712246, 0.03538106009364128, -0.0135...
-0.011517
## Choosing a location for your action If you're developing an action for other people to use, we recommend keeping the action in its own repository instead of bundling it with other application code. This allows you to version, track, and release the action just like any other software. {% ifversion fpt or ghec %} Sto...
https://github.com/github/docs/blob/main//content/actions/how-tos/create-and-publish-actions/manage-custom-actions.md
main
github-actions
[ -0.05963537469506264, -0.06907287985086441, -0.0666041150689125, -0.02696496993303299, 0.0838334709405899, 0.04785863682627678, 0.05766356736421585, 0.115192711353302, -0.03646232932806015, 0.08266659080982208, 0.07601220905780792, 0.07709375023841858, -0.021405940875411034, -0.01847365498...
0.117539
changes that will break existing workflows, such as changing an action's inputs. #### Syntax for referencing tags This example demonstrates how a user can reference a major version tag: ```yaml steps: - uses: actions/javascript-action@v1 ``` This example demonstrates how a user can reference a specific patch release ta...
https://github.com/github/docs/blob/main//content/actions/how-tos/create-and-publish-actions/manage-custom-actions.md
main
github-actions
[ -0.06287114322185516, -0.04223637282848358, 0.055416785180568695, -0.020203059539198875, 0.02116963639855385, -0.008222288452088833, 0.021886643022298813, 0.0035743596963584423, 0.09046659618616104, 0.03118058852851391, -0.010642443783581257, 0.04863154515624046, -0.03920978307723999, -0.0...
0.074646
## Introduction You can write an action to provide a way for users to access your servers via a configured CLI environment on {% data variables.product.prodname\_actions %} runners. Your action should: \* Make it simple for users to specify the version of the CLI to install \* Support multiple operating systems \* Run ...
https://github.com/github/docs/blob/main//content/actions/how-tos/create-and-publish-actions/create-a-cli-action.md
main
github-actions
[ 0.045975200831890106, -0.07640708982944489, -0.05095065385103226, -0.04113082215189934, 0.019196219742298126, -0.010251852683722973, 0.014385752379894257, 0.06994400918483734, -0.045426446944475174, -0.004653050564229488, 0.01198495365679264, 0.01368290837854147, 0.02328130416572094, -0.02...
0.055675
{% data reusables.actions.enterprise-github-hosted-runners %} ## Configuring a workflow to run manually To run a workflow manually, the workflow must be configured to run on the `workflow\_dispatch` event. To trigger the `workflow\_dispatch` event, your workflow must be in the default branch. For more information about...
https://github.com/github/docs/blob/main//content/actions/how-tos/manage-workflow-runs/manually-run-a-workflow.md
main
github-actions
[ -0.014093202538788319, -0.112046979367733, -0.01726660504937172, 0.05836517736315727, -0.014997581019997597, -0.06807653605937958, -0.0017471567261964083, -0.03743261843919754, -0.02327224798500538, -0.02063455805182457, -0.005474310368299484, 0.008460641838610172, 0.002228918019682169, 0....
0.078758
> [!NOTE] > Re-run workflows use the privileges of the actor who initially triggered the workflow, not the privileges of the actor who initiated the re-run. The workflow will also use the same `GITHUB\_SHA` (commit SHA) and `GITHUB\_REF` (git ref) of the original event that triggered the workflow run. ## Re-running all...
https://github.com/github/docs/blob/main//content/actions/how-tos/manage-workflow-runs/re-run-workflows-and-jobs.md
main
github-actions
[ -0.03673333674669266, -0.08254379034042358, 0.028962716460227966, 0.041972145438194275, -0.01548098400235176, -0.02239103801548481, 0.010481967590749264, -0.13939031958580017, -0.006125274114310741, -0.03831792250275612, 0.018217921257019043, 0.047147247940301895, 0.027326395735144615, -0....
-0.006114
{% data reusables.actions.enterprise-github-hosted-runners %} ## Deleting an artifact > [!WARNING] > Once you delete an artifact, it cannot be restored. {% data reusables.repositories.permissions-statement-write %} {% data reusables.actions.artifact-log-retention-statement %} {% data reusables.repositories.navigate-to-...
https://github.com/github/docs/blob/main//content/actions/how-tos/manage-workflow-runs/remove-workflow-artifacts.md
main
github-actions
[ -0.031121594831347466, 0.015952114015817642, 0.008408288471400738, 0.03593217954039574, 0.035806283354759216, -0.08554953336715698, 0.024409476667642593, -0.14168894290924072, 0.04419213533401489, -0.008851519785821438, -0.0007497822516597807, 0.039881765842437744, 0.029335135594010353, -0...
0.09559
{% data reusables.actions.enterprise-github-hosted-runners %} Disabling a workflow allows you to stop a workflow from being triggered without having to delete the file from the repo. You can easily re-enable the workflow again on {% data variables.product.prodname\_dotcom %}. Temporarily disabling a workflow can be use...
https://github.com/github/docs/blob/main//content/actions/how-tos/manage-workflow-runs/disable-and-enable-workflows.md
main
github-actions
[ -0.04709353297948837, 0.016982685774564743, -0.018459590151906013, 0.016891922801733017, 0.06382235884666443, -0.008148453198373318, 0.0051514445804059505, -0.01591366156935692, 0.02232424169778824, -0.013541797176003456, -0.00980382040143013, 0.09322544187307358, 0.013109803199768066, -0....
0.181649
Workflow runs triggered by a contributor's pull request from a fork may require manual approval from a maintainer with write access. You can configure workflow approval requirements for a [repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-act...
https://github.com/github/docs/blob/main//content/actions/how-tos/manage-workflow-runs/approve-runs-from-forks.md
main
github-actions
[ -0.0024381056427955627, -0.09360317885875702, 0.026698077097535133, -0.04224889352917671, 0.05028953030705452, -0.059927988797426224, -0.046103037893772125, -0.06655958294868469, 0.03837479650974274, 0.04200604185461998, -0.0002072179486276582, 0.013617782853543758, -0.016980890184640884, ...
0.062531
{% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.repositories.permissions-statement-write %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %} {% data reusables.repositories.navigate-to-workflow %} 1. To delete a workflow run, select {% octic...
https://github.com/github/docs/blob/main//content/actions/how-tos/manage-workflow-runs/delete-a-workflow-run.md
main
github-actions
[ -0.01706518791615963, -0.018200300633907318, -0.041103851050138474, 0.029765833169221878, 0.008095606230199337, -0.028929077088832855, 0.0027216074522584677, -0.14322377741336823, 0.06598889082670212, -0.03786307945847511, -0.02874315157532692, 0.056035034358501434, 0.009461507201194763, -...
0.095135
{% data reusables.actions.enterprise-github-hosted-runners %} By default, {% data variables.product.github %} stores build logs and artifacts for 90 days, and you can customize this retention period, depending on the type of repository. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-setti...
https://github.com/github/docs/blob/main//content/actions/how-tos/manage-workflow-runs/download-workflow-artifacts.md
main
github-actions
[ -0.023950785398483276, -0.043402865529060364, -0.03239217400550842, 0.05376868695020676, 0.02818397618830204, -0.017755981534719467, 0.02602492831647396, -0.05551636219024658, -0.004354089964181185, 0.02275879494845867, 0.03236052393913269, 0.036286860704422, 0.02555745095014572, 0.0215877...
0.063765
{% data reusables.actions.enterprise-github-hosted-runners %} > [!NOTE] > If a workflow is skipped due to [path filtering](/actions/using-workflows/workflow-syntax-for-github-actions#onpushpull\_requestpull\_request\_targetpathspaths-ignore), [branch filtering](/actions/using-workflows/workflow-syntax-for-github-action...
https://github.com/github/docs/blob/main//content/actions/how-tos/manage-workflow-runs/skip-workflow-runs.md
main
github-actions
[ 0.00042112136725336313, -0.05606740713119507, -0.008594484999775887, 0.027406636625528336, 0.04331635311245918, -0.06556873023509979, 0.0062223463319242, -0.06815101951360703, 0.047666996717453, -0.01788421720266342, 0.0203504990786314, 0.042491987347602844, 0.01975134015083313, -0.0679606...
0.082692
## Canceling a workflow run {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %} {% 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...
https://github.com/github/docs/blob/main//content/actions/how-tos/manage-workflow-runs/cancel-a-workflow-run.md
main
github-actions
[ -0.05871155858039856, 0.03369845822453499, 0.005211313255131245, 0.01566225476562977, 0.025561083108186722, -0.04305826872587204, 0.11866673827171326, -0.13048695027828217, 0.024332020431756973, 0.024610377848148346, -0.007055769674479961, 0.05345439538359642, 0.0004726778715848923, -0.075...
0.074676
This article describes managing caches with the {% data variables.product.prodname\_dotcom %} web interface, but you can also manage them: \* Using the REST API. See [AUTOTITLE](/rest/actions/cache). \* With the `gh cache` subcommand from the command line. See the [GitHub CLI documentation](https://cli.github.com/manua...
https://github.com/github/docs/blob/main//content/actions/how-tos/manage-workflow-runs/manage-caches.md
main
github-actions
[ 0.005493540316820145, -0.024894285947084427, -0.060782209038734436, -0.02811279334127903, 0.01837206445634365, -0.035276148468256, 0.07075140625238419, 0.022415993735194206, -0.016903169453144073, 0.03131181746721268, 0.021609647199511528, 0.03606845438480377, 0.0014624864561483264, -0.071...
0.104502
raw %}${{ github.token }}{% endraw %} GH\_REPO: {% raw %}${{ github.repository }}{% endraw %} BRANCH: refs/pull/{% raw %}${{ github.event.pull\_request.number }}{% endraw %}/merge ``` Alternatively, you can use the API to automatically list or delete all caches on your own cadence. For more information, see [AUTOTITLE]...
https://github.com/github/docs/blob/main//content/actions/how-tos/manage-workflow-runs/manage-caches.md
main
github-actions
[ -0.004467599559575319, -0.0026415076572448015, -0.017811138182878494, -0.007145437877625227, 0.03665206953883171, 0.0038935085758566856, 0.006469291169196367, -0.0063668349757790565, 0.0677938312292099, 0.02201305888593197, -0.01603061333298683, 0.027037115767598152, -0.02649409882724285, ...
0.062113
You may be rate limited by {% data variables.product.prodname\_actions %} when you scale your usage. Some limits can be increased by contacting {% data variables.contact.contact\_support %}. Unless otherwise stated, the expected behavior when a limit is reached is that the workflow/job will get cancelled. These limits ...
https://github.com/github/docs/blob/main//content/actions/reference/limits.md
main
github-actions
[ -0.03508119657635689, -0.04193342849612236, -0.044914569705724716, 0.021953795105218887, 0.030122237280011177, -0.08019513636827469, -0.010130773298442364, 0.039439354091882706, 0.00027242081705480814, 0.014214124530553818, 0.06691936403512955, 0.00181751255877316, -0.009341074153780937, -...
0.083552
limits for all {% data variables.product.github %}-hosted runners](#storage-limits-for-all-github-hosted-runners). | {% octicon "x" aria-label="No" %} | | {% endif %} | | Larger runners | Per runner concurrency limit | Varies by runner type | Established when setting up a runner. Normally 1,000 max for Linux CPU runner...
https://github.com/github/docs/blob/main//content/actions/reference/limits.md
main
github-actions
[ 0.05203107371926308, -0.03496982902288437, -0.12840817868709564, -0.003983755595982075, -0.02203948050737381, -0.023905208334326744, -0.03226329758763313, 0.0028441958129405975, -0.04506929963827133, -0.01792152225971222, 0.01178460381925106, 0.059530749917030334, 0.010067294351756573, -0....
0.134088
that are commonly hit are: \* \*\*Unauthenticated users\*\* \- {% data reusables.rest-api.primary-rate-limit-unauthenticated-users %} \* \*\*Authenticated users\*\* \- {% data reusables.rest-api.primary-rate-limit-authenticated-users %} \* \*\*GitHub app installations\*\* \- {% data reusables.rest-api.primary-rate-limi...
https://github.com/github/docs/blob/main//content/actions/reference/limits.md
main
github-actions
[ -0.013215652666985989, 0.0022179768420755863, -0.049601487815380096, -0.01876583695411682, 0.029441241174936295, -0.011821920052170753, -0.03776171803474426, -0.01663476601243019, 0.020163649693131447, 0.01698511466383934, 0.08576049655675888, -0.003247505286708474, 0.06710696965456009, -0...
0.020192
## Naming your secrets >[!TIP] > To help ensure that {% data variables.product.prodname\_dotcom %} redacts your secrets in logs correctly, avoid using structured data as the values of secrets. The following rules apply to secret names: {% data reusables.actions.actions-secrets-and-variables-naming %} {% data reusables....
https://github.com/github/docs/blob/main//content/actions/reference/security/secrets.md
main
github-actions
[ -0.05453440174460411, -0.03701518476009369, -0.0992870107293129, 0.005431422032415867, 0.006885360926389694, -0.031253665685653687, 0.010591544210910797, 0.03117186948657036, 0.0007040803320705891, 0.03495260700583458, -0.0012715688208118081, 0.021051762625575066, 0.06396514177322388, -0.0...
0.104249
## OIDC token claims To see all the claims supported by {% data variables.product.prodname\_dotcom %}'s OIDC provider, review the `claims\_supported` entries at {% ifversion ghes %}`https://HOSTNAME/\_services/token/.well-known/openid-configuration`{% else %}https://token.actions.githubusercontent.com/.well-known/openi...
https://github.com/github/docs/blob/main//content/actions/reference/security/oidc.md
main
github-actions
[ -0.08789761364459991, 0.011655404232442379, -0.07795147597789764, 0.06648541986942291, 0.08494304865598679, -0.04499959573149681, 0.06613118946552277, 0.06343268603086472, -0.012457015924155712, 0.042219553142786026, 0.0021330935414880514, -0.04231848940253258, 0.0350043959915638, -0.03123...
0.120682
or `public`. | | `repository`| The repository from where the workflow is running. | | `repository\_id`| The ID of the repository from where the workflow is running. | | `repository\_owner`| The name of the organization in which the `repository` is stored. | | `repository\_owner\_id`| The ID of the organization in which...
https://github.com/github/docs/blob/main//content/actions/reference/security/oidc.md
main
github-actions
[ -0.03219487518072128, -0.05465279519557953, -0.09919129312038422, 0.05140773579478264, 0.03373444825410843, -0.03641226142644882, -0.0002526412717998028, -0.043092310428619385, 0.06489692628383636, -0.022599969059228897, -0.0249681007117033, 0.00970332883298397, 0.05465281009674072, -0.075...
0.127613
from workflows running in specific branches, environments. The following sections describe some common subjects you can use. ### Filtering for a specific environment The subject claim includes the environment name when the job references an environment. You can configure a subject that filters for a specific [environme...
https://github.com/github/docs/blob/main//content/actions/reference/security/oidc.md
main
github-actions
[ -0.036094922572374344, -0.01743561029434204, 0.019367292523384094, -0.019258558750152588, 0.06127464398741722, -0.09036141633987427, 0.026675552129745483, -0.07345343381166458, 0.038573525846004486, -0.012718441896140575, -0.09148305654525757, -0.16384698450565338, -0.02114439569413662, 0....
0.079917
for {% ifversion ghec %}`issuer` or {% endif %}`audience` claims. See {% ifversion ghec %}[Customizing the `issuer` value for an enterprise](#customizing-the-issuer-value-for-an-enterprise) and {% endif %}[Customizing the `audience` value](#customizing-the-audience-value). \* You can customize the format of your OIDC c...
https://github.com/github/docs/blob/main//content/actions/reference/security/oidc.md
main
github-actions
[ -0.09505590051412582, 0.020623700693249702, -0.04559536278247833, 0.027733590453863144, 0.04286440461874008, -0.0005943768192082644, 0.04894828051328659, 0.04134441912174225, -0.007112447172403336, -0.03363441675901413, -0.04194376990199089, -0.03228619322180748, 0.023946478962898254, -0.0...
0.095671
include a specific custom claim, such as `job\_workflow\_ref`. You can use the REST API to apply a customization template for the OIDC subject claim; for example, you can require that the `sub` claim within the OIDC token must always include a specific custom claim, such as `job\_workflow\_ref`. For more information, s...
https://github.com/github/docs/blob/main//content/actions/reference/security/oidc.md
main
github-actions
[ -0.16430272161960602, 0.04243144392967224, -0.016539316624403, -0.0086144357919693, 0.032842494547367096, 0.009388715960085392, -0.02175535075366497, 0.027602361515164375, 0.08005961030721664, -0.010316203348338604, -0.09833916276693344, -0.051120173186063766, -0.011400619521737099, 0.0496...
0.11256
a specific value for `job\_workflow\_ref`. For example: `"sub": "job\_workflow\_ref:octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main"`. #### Example: Requiring a reusable workflow and other claims The following example template combines the requirement of a specific reusable workflow with additional ...
https://github.com/github/docs/blob/main//content/actions/reference/security/oidc.md
main
github-actions
[ -0.1469152718782425, 0.03577960282564163, 0.02869243174791336, 0.003755629062652588, 0.024955537170171738, -0.05091005191206932, 0.009600228630006313, -0.02166048251092434, 0.04479379579424858, 0.0013952878070995212, -0.03641897067427635, -0.06161569803953171, 0.042003780603408813, 0.03573...
0.03665
be used to programmatically apply the template to repositories within the organization. A repository administrator can configure their repository to use the template created by the administrator of their organization. To configure the repository to use the organization's template, a repository admin must use the `PUT /...
https://github.com/github/docs/blob/main//content/actions/reference/security/oidc.md
main
github-actions
[ -0.14087463915348053, 0.07763559371232986, -0.013626341708004475, 0.03948166221380234, 0.06237289309501648, -0.0021333007607609034, -0.03170454129576683, 0.043471578508615494, 0.05806947126984596, 0.025459235534071922, -0.008775348775088787, -0.018500857055187225, 0.00630214111879468, 0.04...
0.05623
Find information about security best practices when you are writing workflows and using {% data variables.product.prodname\_actions %} security features. ## Writing workflows ### Use secrets for sensitive information Because there are multiple ways a secret value can be transformed, automatic redaction is not guarantee...
https://github.com/github/docs/blob/main//content/actions/reference/security/secure-use.md
main
github-actions
[ -0.06105918809771538, -0.019838374108076096, -0.09449564665555954, -0.020240213721990585, -0.04271644353866577, 0.03936448320746422, 0.07378525286912918, 0.09506901353597641, 0.013265572488307953, -0.0031606184784322977, 0.0019239626126363873, 0.013115606270730495, 0.03900476545095444, 0.0...
0.098359
secrets are properly redacted, or not shown. It's not always obvious how a command or tool you’re invoking will send errors to `STDOUT` and `STDERR`, and secrets might subsequently end up in error logs. As a result, it is good practice to manually review the workflow logs after testing valid and invalid inputs. For inf...
https://github.com/github/docs/blob/main//content/actions/reference/security/secure-use.md
main
github-actions
[ -0.038945771753787994, 0.032092273235321045, -0.05018119886517525, 0.04332839325070381, 0.025171179324388504, -0.045319054275751114, -0.014332926832139492, -0.0641709640622139, 0.052551623433828354, 0.007467744406312704, -0.017444605007767677, -0.02571968175470829, 0.018146727234125137, 0....
0.021577
For more information, see [AUTOTITLE](/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github\_token). {% ifversion custom-org-roles %} ## Mitigating the risks of untrusted code checkout Similar to script injection attacks, untrusted pull request content that automatically trigg...
https://github.com/github/docs/blob/main//content/actions/reference/security/secure-use.md
main
github-actions
[ -0.08065403252840042, -0.0006890534423291683, -0.04714502766728401, -0.012743071652948856, 0.04384895786643028, -0.007072190288454294, 0.029728515073657036, 0.028878239914774895, 0.06574983149766922, -0.01702461764216423, -0.022438419982790947, 0.012021400034427643, 0.025550713762640953, -...
0.174372
the {% ifversion ghec or ghes %}repository, organization, and enterprise{% else %}repository and organization{% endif %} level to require actions to be pinned to a full-length commit SHA: \* To configure the policy at the repository level, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/en...
https://github.com/github/docs/blob/main//content/actions/reference/security/secure-use.md
main
github-actions
[ 0.018139908090233803, -0.042796723544597626, -0.047533247619867325, -0.031203895807266235, 0.01598404534161091, 0.0217243954539299, -0.014080732129514217, -0.05259321257472038, -0.007579002995043993, 0.06661449372768402, 0.04942082241177559, -0.011933750472962856, -0.007562435697764158, 0....
0.075737
data reusables.actions.dependabot-version-updates-for-actions %} {% ifversion ghec or ghes %} ### Allowing workflows to access internal and private repositories {% data reusables.actions.outside-collaborators-actions %} For more information, see [AUTOTITLE](/actions/creating-actions/sharing-actions-and-workflows-with-y...
https://github.com/github/docs/blob/main//content/actions/reference/security/secure-use.md
main
github-actions
[ -0.11759253591299057, -0.05887342989444733, 0.027224162593483925, -0.04819762706756592, 0.0005350979627110064, 0.047120291739702225, 0.04168444126844406, 0.008400192484259605, 0.015576458536088467, 0.04552874714136124, 0.027581535279750824, 0.02254103124141693, -0.03751455619931221, -0.000...
0.034845
code in a workflow. {% ifversion fpt or ghec %}As a result, self-hosted runners should almost [never be used for public repositories](/actions/security-for-github-actions/security-guides/security-hardening-for-github-actions) on {% data variables.product.github %}, because any user can open pull requests against the re...
https://github.com/github/docs/blob/main//content/actions/reference/security/secure-use.md
main
github-actions
[ -0.03143011033535004, -0.018731292337179184, -0.045935217291116714, 0.03289710730314255, 0.04035009443759918, -0.04008937254548073, -0.04022959992289543, 0.06559726595878601, 0.024676447734236717, -0.00840790569782257, 0.019680751487612724, 0.033320456743240356, 0.0025143870152533054, -0.0...
0.132678
self-hosted runners, then the recommendation is to add your runners at the highest mutual organization or enterprise level. This gives your team a single location to view and manage your runners. \* If you only have a single organization, then adding your runners at the organization level is effectively the same approa...
https://github.com/github/docs/blob/main//content/actions/reference/security/secure-use.md
main
github-actions
[ -0.021810593083500862, -0.05896658077836037, -0.08029240369796753, 0.008954030461609364, 0.008256911300122738, 0.02887863852083683, -0.03955700621008873, 0.050960179418325424, 0.010173753835260868, 0.04959602281451225, 0.03360438346862793, -0.005379750393331051, 0.04744240269064903, 0.0173...
0.134655
you use For actions available on the marketplace, {% data variables.product.prodname\_dotcom %} reviews related security advisories and then adds those advisories to the {% data variables.product.prodname\_advisory\_database %}. You can search the database for actions that you use to find information about existing vul...
https://github.com/github/docs/blob/main//content/actions/reference/security/secure-use.md
main
github-actions
[ -0.03950323164463043, -0.020261485129594803, -0.11043137311935425, 0.06022408604621887, 0.0902736559510231, 0.02208731323480606, 0.07011790573596954, 0.057726506143808365, -0.07472483813762665, 0.01090843416750431, 0.008634823374450207, -0.03825972601771355, 0.06538290530443192, 0.00518047...
0.131172
that is used in other projects, you can use the following {% data variables.product.prodname\_dotcom %} features to enhance the security of the actions you've published. \* Use the dependants view in the Dependency graph to see which projects depend on your code. If you receive a vulnerability report, this will give yo...
https://github.com/github/docs/blob/main//content/actions/reference/security/secure-use.md
main
github-actions
[ -0.10824567079544067, 0.012125644832849503, -0.05925043299794197, -0.009946510195732117, 0.06743481755256653, 0.024918554350733757, 0.045711345970630646, 0.08000882714986801, -0.08003882318735123, 0.026988301426172256, 0.04476563632488251, -0.024739257991313934, 0.0411798357963562, -0.0074...
0.201915
## Reusable workflows Reference information for reusable workflows. ### Access to reusable workflows A reusable workflow can be used by another workflow if any of the following is true: \* Both workflows are in the same repository. \* The called workflow is stored in a public repository{% ifversion ghes %} on {% data v...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/reusing-workflow-configurations.md
main
github-actions
[ -0.018193254247307777, -0.06569285690784454, -0.03728114068508148, -0.023050589486956596, 0.022978898137807846, 0.029232017695903778, 0.08350472152233124, 0.011315048672258854, -0.05612671747803688, -0.01720932498574257, 0.01757093332707882, 0.008911236189305782, 0.015033308416604996, 0.00...
0.059996
jobs that call a reusable workflow When you call a reusable workflow, you can only use the following keywords in the job containing the call: \* [`jobs..name`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob\_idname) \* [`jobs..uses`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsj...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/reusing-workflow-configurations.md
main
github-actions
[ -0.08470291644334793, -0.054880764335393906, -0.01694260537624359, 0.009791962802410126, 0.024450747296214104, -0.02121485210955143, 0.09159611910581589, -0.09834680706262589, -0.0033348649740219116, -0.060187432914972305, -0.012181829661130905, 0.05046281963586807, 0.04896236211061478, 0....
0.071338
only available to private repositories. {% ifversion ghec %} Because public workflow templates require a public `.github` repository, they are not available for {% data variables.product.prodname\_emus %}. {% endif %} ### Granting access for private/internal repositories If you're using a private or internal `.github` ...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/reusing-workflow-configurations.md
main
github-actions
[ 0.035255689173936844, -0.008669453673064709, -0.07576009631156921, -0.03295329585671425, 0.015519959852099419, 0.038879089057445526, 0.007632819470018148, 0.06982915848493576, 0.04904641956090927, -0.015407652594149113, 0.00854842085391283, -0.02942855842411518, -0.021675625815987587, -0.0...
0.074795
{% data reusables.actions.enterprise-github-hosted-runners %} ### USER Docker actions must be run by the default Docker user (root). Do not use the `USER` instruction in your `Dockerfile`, because you won't be able to access the `GITHUB\_WORKSPACE` directory. For more information, see [AUTOTITLE](/actions/reference/var...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/dockerfile-support.md
main
github-actions
[ 0.01356346532702446, 0.0023441410157829523, -0.01699199341237545, 0.01655976101756096, 0.02602081187069416, -0.05003492906689644, -0.013477331958711147, 0.06032547354698181, -0.02501142956316471, 0.032146427780389786, -0.05057036131620407, -0.016106000170111656, 0.04427739605307579, -0.008...
-0.003112
'%d args:' "$#" printf " '%s'" "$@" printf '\n' ``` Your code must be executable. Make sure the `entrypoint.sh` file has `execute` permissions before using it in a workflow. You can modify the permission from your terminal using this command: ```shell chmod +x entrypoint.sh ``` When an `ENTRYPOINT` shell script is not ...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/dockerfile-support.md
main
github-actions
[ 0.04926181957125664, 0.01848651096224785, -0.07613416761159897, -0.0619044154882431, -0.010464520193636417, -0.0678020790219307, 0.0459478385746479, 0.06227948144078255, 0.024274252355098724, 0.006682414561510086, -0.05242137983441353, -0.05439319461584091, 0.04890318587422371, 0.049251053...
0.054719
## Available contexts | Context name | Type | Description | |---------------|------|-------------| | `github` | `object` | Information about the workflow run. For more information, see [`github` context](#github-context). | | `env` | `object` | Contains variables set in a workflow, job, or step. For more information, s...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/contexts.md
main
github-actions
[ -0.024083318188786507, -0.028760062530636787, -0.08697772771120071, 0.060876209288835526, 0.058728475123643875, -0.05822982266545296, 0.05367672070860863, -0.020562874153256416, -0.02241457626223564, -0.05482902005314827, -0.05415183678269386, 0.008307201787829399, 0.05333308130502701, -0....
0.129402
on branch $GITHUB\_REF" ``` {% endraw %} In this example, the `if` statement checks the [`github.ref`](/actions/learn-github-actions/contexts#github-context) context to determine the current branch name; if the name is `refs/heads/main`, then the subsequent steps are executed. The `if` check is processed by {% data var...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/contexts.md
main
github-actions
[ -0.02572164684534073, -0.017958352342247963, -0.07525794953107834, -0.005292157642543316, 0.10372547805309296, -0.025670411065220833, 0.02788121998310089, -0.003959506284445524, 0.03727864846587181, -0.003484137589111924, 0.033547475934028625, 0.022632034495472908, 0.036811232566833496, -0...
0.118284
matrix, job, runner, env, vars, secrets, steps, inputs` | `hashFiles` | | `jobs..steps.with` | `github, needs, strategy, matrix, job, runner, env, vars, secrets, steps, inputs` | `hashFiles` | | `jobs..steps.working-directory` | `github, needs, strategy, matrix, job, runner, env, vars, secrets, steps, inputs` | `hashFi...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/contexts.md
main
github-actions
[ -0.05312144756317139, 0.008627218194305897, -0.16381199657917023, -0.029658805578947067, -0.022792741656303406, -0.03354550898075104, 0.023300552740693092, 0.0470271036028862, -0.035640470683574677, 0.021996047347784042, 0.01985577866435051, 0.02948281727731228, 0.11183338612318039, -0.046...
0.133751
triggered the initial workflow run. If the workflow run is a re-run, this value may differ from `github.triggering\_actor`. Any workflow re-runs will use the privileges of `github.actor`, even if the actor initiating the re-run (`github.triggering\_actor`) has different privileges. | | `github.actor\_id` | `string` | {...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/contexts.md
main
github-actions
[ -0.008675536140799522, -0.03575853258371353, -0.016150474548339844, -0.03153027221560478, -0.02052140422165394, 0.029885906726121902, 0.022649366408586502, 0.018140094354748726, 0.03600772097706795, -0.028721943497657776, -0.022139569744467735, -0.02600223571062088, 0.03706922382116318, 0....
0.087687
{% data reusables.actions.enterprise-github-hosted-runners %} ## About YAML syntax for workflows Workflow files use YAML syntax, and must have either a `.yml` or `.yaml` file extension. {% data reusables.actions.learn-more-about-yaml %} You must store workflow files in the `.github/workflows` directory of your reposito...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/workflow-syntax.md
main
github-actions
[ -0.028921471908688545, -0.08056489378213882, -0.038672443479299545, 0.02050480619072914, 0.02096594125032425, -0.007316499017179012, 0.05576111003756523, 0.02785218134522438, 0.04456574097275734, -0.018073394894599915, 0.011619465425610542, 0.05356353893876076, 0.0046930015087127686, -0.07...
0.142099
`number`, or `string`. ## `on.workflow\_call.outputs` A map of outputs for a called workflow. Called workflow outputs are available to all downstream jobs in the caller workflow. Each output has an identifier, an optional `description,` and a `value.` The `value` must be set to the value of an output from a job within ...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/workflow-syntax.md
main
github-actions
[ -0.05728762596845627, -0.0069100079126656055, -0.021419065073132515, 0.010674001649022102, -0.03981447592377663, -0.027576450258493423, 0.029091883450746536, -0.006283849012106657, 0.054938752204179764, -0.08913600444793701, -0.027025939896702766, -0.017657935619354248, -0.019905896857380867...
0.079943
the `GITHUB\_TOKEN` permissions for all jobs in a workflow You can specify `permissions` at the top level of a workflow, so that the setting applies to all jobs in the workflow. #### Example: Setting the `GITHUB\_TOKEN` permissions for an entire workflow {% data reusables.actions.jobs.setting-permissions-all-jobs-examp...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/workflow-syntax.md
main
github-actions
[ -0.03756077215075493, -0.0846482515335083, -0.04441027343273163, 0.015658274292945862, -0.027340970933437347, -0.018013257533311844, 0.04740489274263382, 0.028411436825990677, -0.01231568306684494, 0.027186201885342598, -0.019234037026762962, 0.038515716791152954, 0.011767992749810219, -0....
0.075256
built-in steps to set up and complete a job. {% data variables.product.prodname\_dotcom %} only displays the first 1,000 checks, however, you can run an unlimited number of steps as long as you are within the workflow usage limits. For more information, see [AUTOTITLE](/actions/learn-github-actions/usage-limits-billing...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/workflow-syntax.md
main
github-actions
[ -0.03782511502504349, -0.039965271949768066, -0.06324261426925659, 0.003406950505450368, 0.001346216187812388, -0.057927243411540985, -0.02882877178490162, 0.06663664430379868, -0.053374987095594406, 0.0015549762174487114, -0.0036988272331655025, 0.003940128721296787, 0.009777842089533806, ...
0.148138
critical fixes and security patches while still retaining compatibility. Note that this behavior is at the discretion of the action's author. \* Using the default branch of an action may be convenient, but if someone releases a new major version with a breaking change, your workflow could break. Some actions require in...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/workflow-syntax.md
main
github-actions
[ -0.05536777526140213, -0.023319128900766373, -0.0003025987825822085, -0.020794780924916267, 0.04606632515788078, -0.028495270758867264, -0.04283430799841881, -0.06030873581767082, -0.026218073442578316, 0.0230883676558733, -0.0035999626852571964, 0.07690735906362534, -0.07685238867998123, ...
0.083608
not provide a `name`, the step name will default to the text specified in the `run` command. Commands run using non-login shells by default. You can choose a different shell and customize the shell used to run commands. For more information, see [`jobs..steps[\*].shell`](#jobsjob\_idstepsshell). Each `run` keyword repr...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/workflow-syntax.md
main
github-actions
[ -0.049278367310762405, 0.00034453850821591914, -0.029073182493448257, -0.00514580961316824, -0.01576361618936062, -0.04796380549669266, -0.043413158506155014, 0.006790101062506437, 0.012188894674181938, 0.06648316234350204, -0.027878187596797943, -0.030923951417207718, 0.004419470671564341, ...
0.104493
\* You can take full control over shell parameters by providing a template string to the shell options. For example, `bash {0}`. \* `sh`-like shells exit with the exit code of the last command executed in a script, which is also the default behavior for actions. The runner will report the status of the step as fail/suc...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/workflow-syntax.md
main
github-actions
[ 0.032408084720373154, 0.03449646010994911, -0.049329813569784164, 0.08324877917766571, 0.026791641488671303, 0.07248172909021378, -0.014498330652713776, 0.02656743675470352, -0.007771153934299946, 0.07990185171365738, -0.06552769988775253, -0.031354133039712906, 0.000424950267188251, -0.00...
0.031357
uses: octo-org/action-name@main with: entrypoint: /a/different/executable ``` The `entrypoint` keyword is meant to be used with Docker container actions, but you can also use it with JavaScript actions that don't define any inputs. ## `jobs..steps[\*].env` Sets variables for steps to use in the runner environment. You ...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/workflow-syntax.md
main
github-actions
[ -0.048216067254543304, 0.0016761320875957608, -0.08469599485397339, 0.034953538328409195, -0.00593458442017436, -0.02846102975308895, 0.00805810559540987, -0.014094693586230278, -0.0032268259674310684, -0.030989225953817368, -0.04315357655286789, 0.0013154556509107351, -0.0025813502725213766...
0.109798
to create a multi-dimensional matrix. A job will run for each possible combination of the variables. For example, the following workflow specifies two variables: \* Two operating systems specified in the `os` variable \* Three Node.js versions specified in the `version` variable The workflow will run six jobs, one for ...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/workflow-syntax.md
main
github-actions
[ -0.0006901324377395213, -0.024477606639266014, -0.108205646276474, 0.03599974513053894, -0.026782076805830002, -0.01963363029062748, -0.06759870797395706, -0.06172054633498192, -0.016563015058636665, 0.02787260338664055, -0.0070384182035923, 0.05307765677571297, 0.008610537275671959, -0.00...
-0.003758
to host service containers for a job in a workflow. Service containers are useful for creating databases or cache services like Redis. The runner automatically creates a Docker network and manages the life cycle of the service containers. If you configure your job to run in a container, or your step uses container acti...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/workflow-syntax.md
main
github-actions
[ -0.053630318492650986, 0.022015368565917015, -0.061942826956510544, -0.02533133141696453, -0.015543741174042225, -0.05391078069806099, -0.05998249351978302, -0.012189877219498158, -0.0026334496214985847, 0.005883479490876198, -0.10775279998779297, 0.008171440102159977, -0.016566826030611992,...
0.079475
## `jobs..services..options` Additional Docker container resource options. For a list of options, see [`docker create` options](https://docs.docker.com/engine/reference/commandline/create/#options). > [!WARNING] > The `--network` option is not supported. ## `jobs..uses` The location and version of a reusable workflow f...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/workflow-syntax.md
main
github-actions
[ -0.06918814778327942, 0.025309575721621513, 0.005991639103740454, 0.051665060222148895, 0.0010787720093503594, -0.03493958339095116, 0.01778385229408741, -0.03838557377457619, -0.05178123340010643, -0.02456880919635296, -0.06307563185691833, 0.04158881679177284, 0.013921835459768772, 0.010...
0.023632
and `!` are special characters in YAML. If you start a pattern with `\*`, `[`, or `!`, you must enclose the pattern in quotes. Also, if you use a [flow sequence](https://yaml.org/spec/1.2.2/#flow-sequences) with a pattern containing `[` and/or `]`, the pattern must be enclosed in quotes. ```yaml # Valid paths: - '\*\*/...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/workflow-syntax.md
main
github-actions
[ -0.0177372507750988, -0.007903475314378738, 0.032414693385362625, -0.0650869682431221, 0.03318006545305252, -0.04236596077680588, 0.007924458011984825, -0.015867382287979126, 0.06228809431195259, -0.019146721810102463, -0.015257873572409153, -0.015806445851922035, -0.010382919572293758, -0...
0.011735
`docs` directory anywhere in the repository. | `docs/hello.md` `dir/docs/my-file.txt` `space/docs/plan/space.doc` | | `'\*\*/README.md'` | A README.md file anywhere in the repository. | `README.md` `js/README.md` | | `'\*\*/\*src/\*\*'` | Any file in a folder with a `src` suffix anywhere in the repository. | `a/src/app...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/workflow-syntax.md
main
github-actions
[ -0.06711471825838089, -0.02315792813897133, -0.04094121977686882, -0.04090060666203499, 0.09040895104408264, -0.02378634363412857, 0.01024075411260128, 0.06937691569328308, 0.07497040927410126, 0.044020555913448334, 0.06148075312376022, 0.10458140075206757, 0.054231077432632446, -0.0011348...
0.011558
{% data reusables.actions.enterprise-github-hosted-runners %} ## About workflow commands Actions can communicate with the runner machine to set environment variables, output values used by other actions, add debug messages to the output logs, and other tasks. Most workflow commands use the `echo` command in a specific ...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/workflow-commands.md
main
github-actions
[ 0.04904913902282715, -0.026648031547665596, -0.0760466530919075, 0.07768677175045013, -0.02671229839324951, -0.014636141248047352, 0.025955896824598312, 0.029255099594593048, 0.000908521527890116, 0.01166441012173891, -0.014693616889417171, -0.04694743454456329, 0.04965468868613243, -0.041...
0.093169
warning message and prints the message to the log. {% data reusables.actions.message-annotation-explanation %} ```text copy ::warning file={name},line={line},endLine={endLine},title={title}::{message} ``` {% data reusables.actions.message-parameters %} ### Example: Setting a warning message {% bash %} ```bash copy echo...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/workflow-commands.md
main
github-actions
[ 0.035847824066877365, 0.03001854196190834, -0.008473730646073818, 0.10650038719177246, 0.0814051628112793, 0.008272653445601463, 0.11039088666439056, 0.03327860310673714, 0.029238516464829445, 0.004490568768233061, 0.03676779195666313, -0.08446025103330612, 0.07954810559749603, -0.00193499...
0.0594
ubuntu-latest steps: - id: sets-a-secret name: Generate, mask, and output a secret run: | the\_secret=$((RANDOM)) echo "::add-mask::$the\_secret" echo "secret-number=$the\_secret" >> "$GITHUB\_OUTPUT" - name: Use that secret output (protected by a mask) run: |{% raw %} echo "the secret number is ${{ steps.sets-a-secret...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/workflow-commands.md
main
github-actions
[ -0.020729878917336464, -0.02007877826690674, -0.1054229885339737, 0.07249905914068222, 0.031126417219638824, 0.009824542328715324, 0.02274928241968155, -0.04210493713617325, 0.03895234689116478, 0.039978768676519394, 0.03801487386226654, -0.046701084822416306, 0.047676604241132736, -0.0659...
-0.00859
Make sure the token you're using is randomly generated and unique for each run. ```text copy ::{endtoken}:: ``` ### Example: Stopping and starting workflow commands {% bash %} ```yaml copy jobs: workflow-command-job: runs-on: ubuntu-latest steps: - name: Disable workflow commands run: | echo '::warning:: This is a warn...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/workflow-commands.md
main
github-actions
[ -0.003889373503625393, 0.01236666552722454, -0.0010571840684860945, 0.050519783049821854, 0.10965873301029205, 0.03202353045344353, 0.0356171689927578, -0.06318702548742294, 0.05758723244071007, -0.008124702610075474, 0.016441890969872475, -0.10047220438718796, -0.014035003259778023, -0.02...
0.039344
name: Store build timestamp run: echo "BUILD\_TIME=$(date +'%T')" >> $GITHUB\_ENV - name: Deploy using stored timestamp run: echo "Deploying at $BUILD\_TIME" ``` {% powershell %} > [!NOTE] > PowerShell versions 5.1 and below (`shell: powershell`) do not use UTF-8 by default, so you must specify the UTF-8 encoding. For ...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/workflow-commands.md
main
github-actions
[ 0.06467602401971817, -0.0002660163736436516, -0.05658143013715744, 0.018770065158605576, -0.017788013443350792, 0.0698966458439827, 0.012240193784236908, -0.020900970324873924, 0.03758009523153305, 0.06639060378074646, 0.0020035833586007357, -0.09961897879838943, 0.002000696025788784, 0.02...
-0.060551
section to define multi-line environment variables. {% bash %} ```bash copy echo "{name}={value}" >> "$GITHUB\_OUTPUT" ``` {% endbash %} {% powershell %} ```powershell copy "{name}=value" >> $env:GITHUB\_OUTPUT ``` {% endpowershell %} ### Example of setting an output parameter {% bash %} This example demonstrates how t...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/workflow-commands.md
main
github-actions
[ 0.06163064017891884, -0.026035891845822334, -0.06041428819298744, 0.07308351248502731, 0.011238538660109043, 0.051390063017606735, 0.0852012112736702, 0.010867240838706493, -0.0203852578997612, 0.011897263117134571, -0.03977157548069954, -0.11435888707637787, 0.0532514713704586, -0.0519211...
-0.012859
``` {% endpowershell %} ### Overwriting job summaries To clear all content for the current step, you can use `>` to overwrite any previously added content in Bash, or remove `-Append` in PowerShell #### Example of overwriting job summaries {% bash %} ```yaml - name: Overwrite Markdown run: | echo "Adding some Markdown ...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/workflow-commands.md
main
github-actions
[ 0.012328089214861393, 0.046416301280260086, 0.028291162103414536, 0.026382489129900932, 0.0493522547185421, 0.046403151005506516, -0.019408728927373886, -0.041062574833631516, 0.04823464900255203, 0.07331547141075134, -0.010485210455954075, 0.006225238088518381, 0.039037443697452545, -0.01...
0.006778
{% data reusables.actions.types-of-actions %} ## `name` \*\*Required\*\* The name of your action. {% data variables.product.prodname\_dotcom %} displays the `name` in the \*\*Actions\*\* tab to help visually identify actions in each job. ## `author` \*\*Optional\*\* The name of the action's author. ## `description` \*\...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/metadata-syntax.md
main
github-actions
[ -0.021299060434103012, -0.012686106376349926, -0.07740388810634613, 0.038664426654577255, -0.01765364408493042, 0.041911929845809937, 0.14425639808177948, 0.0748024731874466, -0.11696559190750122, 0.004078767262399197, 0.004428924527019262, -0.0518130287528038, 0.052382927387952805, 0.0053...
0.073979
in a workflow. For more information on setting outputs in an action, see [AUTOTITLE](/actions/using-workflows/workflow-commands-for-github-actions#setting-an-output-parameter). ### Example: Declaring outputs for Docker container and JavaScript actions ```yaml outputs: sum: # id of the output description: 'The sum of th...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/metadata-syntax.md
main
github-actions
[ -0.021587088704109192, 0.003530851099640131, -0.05664743483066559, 0.014906219206750393, -0.017666466534137726, 0.014656956307590008, 0.033633265644311905, 0.004071040078997612, 0.05752978473901749, -0.02097780629992485, -0.04870759695768356, -0.06566621363162994, 0.054602738469839096, -0....
0.122205
`post:` action runs a script called `cleanup.js`: ```yaml runs: using: 'node24' main: 'index.js' post: 'cleanup.js' ``` The `post:` action always runs by default but you can override this using `post-if`. ### `runs.post-if` \*\*Optional\*\* Allows you to define conditions for the `post:` action execution. The `post:` a...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/metadata-syntax.md
main
github-actions
[ -0.039420366287231445, 0.010347113944590092, 0.01786312274634838, 0.006075813435018063, 0.04595291242003441, -0.08290338516235352, -0.046708445996046066, -0.05628326162695885, 0.053564224392175674, 0.07638377696275711, 0.005250949412584305, 0.0860290676355362, -0.047054216265678406, 0.0100...
0.1024
commit SHA of a released action version is the safest for stability and security. \* Using the specific major action version allows you to receive critical fixes and security patches while still maintaining compatibility. It also assures that your workflow should still work. \* Using the default branch of an action may...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/metadata-syntax.md
main
github-actions
[ -0.00047651768545620143, -0.03522266820073128, -0.013173609040677547, -0.04954592511057854, 0.03248060122132301, 0.042714688926935196, -0.04507357254624367, -0.06685956567525864, 0.05658108368515968, 0.041258104145526886, 0.03705501928925514, 0.08945059776306152, -0.025718828663229942, -0....
0.05033
sets it if one wasn't already specified. Use `entrypoint` when the `Dockerfile` does not specify an `ENTRYPOINT` or you want to override the `ENTRYPOINT` instruction. If you omit `entrypoint`, the commands you specify in the Docker `ENTRYPOINT` instruction will execute. The Docker `ENTRYPOINT` instruction has a \_shell...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/metadata-syntax.md
main
github-actions
[ -0.006803448777645826, 0.021119961515069008, -0.04672113433480263, -0.011542168445885181, -0.0252423956990242, -0.013832099735736847, 0.061261340975761414, 0.051108218729496, 0.02222798764705658, 0.03437613695859909, -0.03311388939619064, -0.0007485483656637371, 0.06473058462142944, -0.041...
0.067811
briefcase * calendar * camera-off * camera * cast * check-circle * check-square * check * chevron-down * chevron-left * chevron-right * chevron-up * chevrons-down * chevrons-left * chevrons-right * chevrons-up * circle * clipboard * clock * cloud-drizzle * cloud-lightning * cloud-off * cloud-rain * cloud-snow * cloud *...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/metadata-syntax.md
main
github-actions
[ -0.015758896246552467, 0.007449882570654154, -0.021518858149647713, 0.0006376145174726844, 0.09898415952920914, 0.03457249701023102, 0.07033958286046982, -0.01995680294930935, -0.005071697290986776, 0.037132296711206436, 0.02340289019048214, 0.02424558252096176, 0.04065673053264618, -0.022...
0.105531
%} {% endif %}
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/metadata-syntax.md
main
github-actions
[ 0.07199741154909134, 0.10648369789123535, -0.027777601033449173, 0.019711626693606377, 0.05539136379957199, 0.02946513704955578, 0.034136924892663956, 0.06406693905591965, 0.0005953700747340918, 0.022352486848831177, 0.09547361731529236, -0.043611519038677216, -0.010353568941354752, 0.0588...
0.165722
## Deployment protection rules Deployment protection rules require specific conditions to pass before a job referencing the environment can proceed. You can use deployment protection rules to require a manual approval, delay a job, or restrict the environment to certain branches. You can also create and implement custo...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/deployments-and-environments.md
main
github-actions
[ -0.02600252442061901, -0.02759047970175743, -0.051964737474918365, -0.026514625176787376, 0.0651824027299881, -0.015935733914375305, 0.03802270442247391, 0.02526894584298134, -0.04195592179894447, 0.0740945041179657, 0.012987182475626469, -0.03829684481024742, 0.08008085936307907, 0.000351...
0.126224
triggered by `pull\_request` events to deploy to the environment. Wildcard characters will not match `/`, to match branches or tags that begin with `release/` and contain an additional single slash, use `release/\*/\*`. For more information about syntax options for deployment branches, see the [Ruby `File.fnmatch` docu...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/deployments-and-environments.md
main
github-actions
[ 0.012573705986142159, -0.02190639078617096, -0.00020508430316112936, -0.02166554145514965, 0.06010749936103821, -0.016450852155685425, 0.02003924362361431, 0.08006279915571213, -0.0520663745701313, 0.05342401564121246, 0.05115261301398277, -0.006050164811313152, -0.01109418272972107, 0.029...
0.03496
When canceling a workflow run, you may be running other software that uses resources related to the workflow run. To help you free up resources related to the workflow run, it may help to understand the steps {% data variables.product.prodname\_dotcom %} performs to cancel a workflow run. 1. To cancel the workflow run,...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/workflow-cancellation.md
main
github-actions
[ -0.05773939937353134, 0.01667679473757744, 0.004123582970350981, -0.004295999649912119, 0.04403643310070038, -0.06616640090942383, 0.05606449395418167, -0.03840647637844086, 0.03614770621061325, 0.020804649218916893, 0.011220095679163933, 0.0558193102478981, -0.007957491092383862, -0.09787...
0.156614
## `cache` action usage The [`cache` action](https://github.com/actions/cache) will attempt the following sequence when restoring a cache: 1. First, it searches for an exact match to your provided `key`. 1. If no exact match is found, it will search for partial matches of the `key`. 1. If there is still no match found,...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/dependency-caching.md
main
github-actions
[ -0.0556306391954422, -0.027830136939883232, 0.023704053834080696, 0.0509641095995903, 0.0002936602395493537, -0.10176198184490204, 0.055659402161836624, -0.08071991801261902, 0.07511619478464127, 0.019283847883343697, 0.037428151816129684, 0.10040832310914993, 0.005452018231153488, -0.1064...
0.054584
miss occurs, the action also searches your specified `restore-keys` for any matches: 1. If you provide `restore-keys`, the `cache` action sequentially searches for any caches that match the list of `restore-keys`. \* When there is an exact match, the action restores the files in the cache to the `path` directory. \* If...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/dependency-caching.md
main
github-actions
[ -0.07849161326885223, -0.007168891374021769, 0.019857635721564293, 0.048360589891672134, 0.03679104149341583, -0.050063975155353546, 0.05101308971643448, -0.0739452913403511, 0.06885844469070435, -0.000588791910558939, 0.03984517604112625, 0.07908698171377182, -0.024632573127746582, -0.111...
0.081438
If there is no hit, it searches for prefix-matches for `key`, and if there is still no hit, it searches for `restore-keys` and the \_version\_. If there are still no hits in the current branch, the `cache` action retries the same steps on the default branch. Please note that the scope restrictions apply during the sear...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/dependency-caching.md
main
github-actions
[ -0.01911168172955513, -0.03202449902892113, 0.045105088502168655, 0.052057329565286636, 0.012035388499498367, -0.07290325313806534, -0.0155876399949193, -0.08841271698474884, 0.05847107991576195, -0.013285202905535698, 0.017439130693674088, 0.08191683143377304, -0.020676467567682266, -0.11...
0.043229
`feature-a`, a workflow run triggered on a pull request would have access to caches created in the default `main` branch, the base `feature-a` branch, and the current `feature-b` branch. Workflow runs cannot restore caches created for child branches or sibling branches. For example, a cache created for the child `featu...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/dependency-caching.md
main
github-actions
[ -0.037635479122400284, -0.06051617115736008, -0.021516649052500725, -0.02929716743528843, 0.011232554912567139, -0.047295067459344864, -0.006257450673729181, -0.020556576550006866, 0.056498438119888306, -0.01604219153523445, -0.0011274946155026555, 0.061233311891555786, -0.00290638767182827,...
0.036388
functionality is only available to users with a payment method on file who opt in by configuring cache settings{% endif %}. See [AUTOTITLE](/actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/manage-caches).{% ifversion ghes %} You can also increase the cache size limit for a repository. For ...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/dependency-caching.md
main
github-actions
[ -0.02359996922314167, -0.029136763885617256, -0.04323406144976616, -0.012002132833003998, -0.029733408242464066, -0.053136445581912994, -0.028011245653033257, 0.03431978076696396, 0.03130404278635979, 0.057921141386032104, -0.005348409526050091, 0.06874294579029083, 0.004390439949929714, -...
0.048638
This article lists the supported variables you can use in {% data variables.product.prodname\_actions %} workflows, including environment variables, configuration variables, and default variables provided by {% data variables.product.github %}. Use this reference to look up variable names, naming conventions, limits, a...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/variables.md
main
github-actions
[ -0.022088870406150818, -0.06220466271042824, -0.08267935365438461, -0.00928373634815216, 0.01841229945421219, 0.027091283351182938, 0.09064792096614838, 0.08151192218065262, -0.033480361104011536, -0.04991249740123749, 0.003327196929603815, -0.0071837157011032104, 0.04980996623635292, -0.0...
0.096482
`workflow\_dispatch`. | | `GITHUB\_EVENT\_PATH` | The path to the file on the runner that contains the full event webhook payload. For example, `/github/workflow/event.json`. | | `GITHUB\_GRAPHQL\_URL` | Returns the GraphQL API URL. For example: `{% data variables.product.graphql\_url %}`. | | `GITHUB\_HEAD\_REF` | The...
https://github.com/github/docs/blob/main//content/actions/reference/workflows-and-actions/variables.md
main
github-actions
[ -0.07948504388332367, 0.03106760047376156, -0.03407374396920204, 0.04458007961511612, -0.015565205365419388, -0.05990126356482506, -0.03254152461886406, 0.013610659167170525, 0.04599239304661751, -0.0043817246332764626, -0.03766295686364174, -0.06389882415533066, -0.0007905002566985786, -0...
0.109001