content
large_stringlengths
3
20.5k
url
large_stringlengths
53
192
branch
large_stringclasses
4 values
source
large_stringclasses
51 values
embeddings
listlengths
384
384
score
float64
-0.21
0.65
{% 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
bash %} ```yaml copy on: push jobs: generate-a-secret-output: runs-on: 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 m...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/workflow-commands.md
main
github-actions
[ -0.018709968775510788, 0.00046623373054899275, -0.09209178388118744, 0.05793950706720352, 0.020529979839920998, 0.013634894974529743, 0.025189688429236412, -0.04644358158111572, 0.04042375460267067, 0.021872907876968384, 0.03797031566500664, -0.05404595285654068, 0.02886022813618183, -0.06...
0.009465
you used to stop workflow commands. > [!WARNING] > 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 workfl...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/workflow-commands.md
main
github-actions
[ -0.003042781725525856, -0.0010191132314503193, -0.009038991294801235, 0.05330539122223854, 0.120280422270298, 0.021053403615951538, 0.03688111528754234, -0.07932148873806, 0.05172381177544594, -0.009921977296471596, 0.0005702265771105886, -0.09874765574932098, -0.026598937809467316, -0.025...
0.049899
commit SHAs, or artifact names: ```yaml copy steps: - 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...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/workflow-commands.md
main
github-actions
[ 0.0667523741722107, -0.0054658264853060246, -0.04315182566642761, 0.004285506438463926, -0.0022537815384566784, 0.05763068422675133, 0.0011737084714695811, -0.052056606858968735, 0.04920559003949165, 0.09155331552028656, 0.00951128825545311, -0.08921569585800171, 0.016620555892586708, 0.01...
-0.050893
with the same technique used in the [Multiline strings](/actions/using-workflows/workflow-commands-for-github-actions#multiline-strings) section to define multi-line environment variables. {% bash %} ```bash copy echo "{name}={value}" >> "$GITHUB\_OUTPUT" ``` {% endbash %} {% powershell %} ```powershell copy "{name}=va...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/workflow-commands.md
main
github-actions
[ 0.03861493617296219, -0.040714528411626816, -0.07255461812019348, 0.06388057768344879, -0.00010578065848676488, 0.04007282853126526, 0.058662284165620804, 0.00015039091522339731, 0.014429925940930843, -0.002447860548272729, -0.059768762439489365, -0.09028000384569168, 0.05945117771625519, ...
-0.008004
$env:GITHUB\_STEP\_SUMMARY "- How about a third one?" >> $env:GITHUB\_STEP\_SUMMARY ``` {% 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 summar...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/workflow-commands.md
main
github-actions
[ 0.012527712620794773, 0.024582447484135628, 0.01805844157934189, 0.0290741715580225, 0.061103176325559616, 0.04085977002978325, -0.020778372883796692, -0.03775796294212341, 0.046545058488845825, 0.07937594503164291, -0.012063177302479744, 0.0005110068595968187, 0.04422903060913086, -0.0359...
0.012483
{% 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.01785653457045555, -0.040711719542741776, -0.06297959387302399, -0.02344629168510437, -0.022258512675762177, -0.053333524614572525, -0.008769895881414413, 0.03857153654098511, 0.03651740029454231, 0.06784430891275406, 0.012141398154199123, 0.06293949484825134, -0.002406751736998558, -0....
0.056686
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
%} For example, `D:\a\\_temp` | | `RUNNER\_TOOL\_CACHE` | {% data reusables.actions.runner-tool-cache-description %} For example, `C:\hostedtoolcache\windows` | > [!NOTE] > If you need to use a workflow run's URL from within a job, you can combine these variables: `$GITHUB\_SERVER\_URL/$GITHUB\_REPOSITORY/actions/runs/...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/variables.md
main
github-actions
[ 0.012597892433404922, -0.02279430441558361, -0.05479957163333893, 0.03342539817094803, -0.052374403923749924, -0.008729013614356518, 0.01945280097424984, 0.0048157647252082825, -0.008628303185105324, -0.0032402235083281994, -0.05030631273984909, -0.007643487304449081, 0.022732477635145187, ...
0.011579
variables is less than 256 KB. If the total size of repository variables exceeds 256 KB, only the repository variables that fall below the limit will be available (as sorted alphabetically by variable name). \* Up to 1,000 organization variables, if the total combined size of repository and organization variables is le...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/variables.md
main
github-actions
[ 0.07161186635494232, -0.04274945333600044, -0.07364482432603836, 0.041365984827280045, -0.014264749363064766, -0.05545034259557724, -0.014653800055384636, 0.034878525882959366, -0.04389195889234543, 0.022079627960920334, 0.0070939925499260426, 0.012619450688362122, 0.07920290529727936, 0.0...
0.030779
## About events that trigger workflows Workflow triggers are events that cause a workflow to run. For more information about how to use workflow triggers, see [AUTOTITLE](/actions/using-workflows/triggering-a-workflow). Some events have multiple activity types. For these events, you can specify which activity types wil...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md
main
github-actions
[ -0.02857338637113571, -0.00009583339124219492, -0.008225705474615097, -0.04913001134991646, 0.05330877751111984, -0.02524358592927456, 0.053911495953798294, -0.036286547780036926, 0.0674586147069931, -0.0472564771771431, -0.05391160026192665, -0.0898146703839302, 0.025372304022312164, -0.0...
0.133389
[AUTOTITLE](/graphql/reference/checks#object-checksuite) in the GraphQL API documentation or [AUTOTITLE](/rest/checks/suites). For example, you can run a workflow when a check suite has been `completed`. ```yaml on: check\_suite: types: [completed] ``` ## `create` | Webhook event payload | Activity types | `GITHUB\_SHA...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md
main
github-actions
[ -0.0667538046836853, 0.04653221368789673, -0.02677166275680065, 0.0132004264742136, 0.01025628112256527, -0.030497871339321136, 0.03793840482831001, -0.06495030224323273, 0.06964976340532303, 0.07027942687273026, -0.02249518781900406, -0.09709691256284714, 0.056150343269109726, 0.009203941...
0.054289
activity type, see [AUTOTITLE](/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion). {% data reusables.developer-site.limit\_workflow\_to\_activity\_types %} > \* {% data reusables.actions.branch-requirement %} > \* {% data reusables.webhooks.discussions-webhooks-beta %} Runs your workflow when a discu...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md
main
github-actions
[ -0.09848839789628983, -0.009891383349895477, -0.02085573971271515, 0.024646159261465073, -0.014636822044849396, -0.033546265214681625, 0.055307190865278244, -0.02427191659808159, 0.08498857170343399, 0.01741543971002102, -0.08411698043346405, -0.05846991389989853, 0.008410695940256119, 0.0...
0.075307
branch | Default branch | > [!NOTE] > \* {% data reusables.developer-site.multiple\_activity\_types %} For information about each activity type, see [AUTOTITLE](/webhooks-and-events/webhooks/webhook-events-and-payloads#issue\_comment). {% data reusables.developer-site.limit\_workflow\_to\_activity\_types %} > \* {% dat...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md
main
github-actions
[ -0.05847008526325226, -0.000514100887812674, 0.01233992911875248, 0.060940876603126526, -0.0032383855432271957, -0.013924228958785534, -0.0018432961078360677, -0.036328308284282684, 0.0539642795920372, 0.04191184043884277, -0.06460566073656082, -0.013359254226088524, 0.038451872766017914, ...
0.043742
issue, pull request, or discussion, use the `labeled` or `unlabeled` activity types for the [`issues`](#issues), [`pull\_request`](#pull\_request), [`pull\_request\_target`](#pull\_request\_target), or [`discussion`](#discussion) events instead. For example, you can run a workflow when a label has been `created` or `de...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md
main
github-actions
[ -0.049505721777677536, -0.03320368379354477, -0.029120124876499176, 0.01788610778748989, 0.051382359117269516, -0.005631302483379841, 0.074837826192379, -0.04831477254629135, 0.09794639050960541, -0.035331372171640396, 0.010949509218335152, -0.06413856148719788, -0.004795139655470848, 0.00...
0.118536
{% data reusables.actions.branch-requirement %} > \* This event only occurs for projects owned by the workflow's repository, not for organization-owned or user-owned projects or for projects owned by another repository. Runs your workflow when a {% data variables.projects.projects\_v1\_board %} is created or modified. ...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md
main
github-actions
[ -0.01148178894072771, 0.011963613331317902, -0.029957858845591545, 0.03219912573695183, -0.033444881439208984, 0.002344373846426606, 0.0346396341919899, -0.022616419941186905, 0.01340909581631422, -0.002740593161433935, -0.036490242928266525, -0.04616769775748253, -0.010807039216160774, 0....
0.023611
[AUTOTITLE](/rest/repos#edit). For example, you can run a workflow when the `public` event occurs. ```yaml on: public ``` ## `pull\_request` | Webhook event payload | Activity types | `GITHUB\_SHA` | `GITHUB\_REF` | | --------------------- | -------------- | ------------ | -------------| | [`pull\_request`](/webhooks-a...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md
main
github-actions
[ -0.08682144433259964, -0.0004649712354876101, -0.0015333369374275208, 0.010981316678225994, 0.028280092403292656, -0.016283785924315453, 0.02532544918358326, -0.00030933113885112107, 0.07741440087556839, 0.011999932117760181, -0.004338440950959921, -0.05251898244023323, -0.009603051468729973...
0.107841
run a workflow when a pull request has been opened or reopened. ```yaml on: pull\_request: types: [opened, reopened] ``` You can use the event context to further control when jobs in your workflow will run. For example, this workflow will run when a review is requested on a pull request, but the `specific\_review\_requ...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md
main
github-actions
[ -0.04109794273972511, -0.04211197420954704, -0.04004736244678497, 0.022855177521705627, 0.0366506390273571, -0.03454086557030678, -0.02291375771164894, -0.05868640914559364, 0.04654230549931526, 0.0020971843041479588, -0.04123983904719353, -0.005585325416177511, -0.08817640691995621, 0.004...
0.031987
a pull request (not on a pull request's diff) is created, edited, or deleted, use the [`issue\_comment`](#issue\_comment) event. For activity related to pull request reviews or pull request review comments, use the [`pull\_request\_review`](#pull\_request\_review) or [`pull\_request\_review\_comment`](#pull\_request\_r...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md
main
github-actions
[ -0.13043411076068878, -0.014408630318939686, 0.01756231114268303, 0.026508040726184845, 0.0584862120449543, -0.04008236527442932, 0.02975822240114212, -0.011644921265542507, 0.05858749896287918, 0.044171907007694244, 0.020437132567167282, -0.051157400012016296, -0.0026292551774531603, -0.0...
0.061154
branch | Default branch | | {% endif %} | > [!NOTE] > {% data reusables.developer-site.multiple\_activity\_types %} For information about each activity type, see [AUTOTITLE](/webhooks-and-events/webhooks/webhook-events-and-payloads#pull\_request). By default, a workflow only runs when a `pull\_request\_target` event's ...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md
main
github-actions
[ 0.012897209264338017, -0.04367785528302193, 0.007622897624969482, -0.015582366846501827, 0.02131444215774536, -0.022576693445444107, 0.05766671895980835, -0.0029388731345534325, 0.04558449983596802, -0.048376016318798065, -0.06065041944384575, -0.044125791639089584, 0.0023737044539302588, ...
0.11362
[!NOTE] > {% data reusables.actions.branch-paths-filter %} For example, the following workflow will only run when a pull request that includes a change to a JavaScript (`.js`) file is opened on a branch whose name starts with `releases/`: > > ```yaml > on: > pull\_request\_target: > types: > - opened > branches: > - 'r...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md
main
github-actions
[ -0.0662158876657486, -0.03357478976249695, 0.07202766090631485, 0.034950658679008484, 0.05037065967917442, -0.044472016394138336, 0.02366557903587818, -0.0014687844086438417, 0.07750487327575684, -0.01304149441421032, -0.00302509474568069, 0.04067010059952736, -0.08850613236427307, -0.0301...
0.053804
can use the `tags` or `tags-ignore` filter to configure your workflow to only run when specific tags are pushed. For more information, see [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#onpushbranchestagsbranches-ignoretags-ignore). For example, this workflow will run when someone pushes a tag ...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md
main
github-actions
[ -0.04222690314054489, -0.019119706004858017, 0.03245610371232033, 0.00579164968803525, 0.05183125287294388, -0.0630965530872345, 0.012315801344811916, -0.01924586482346058, 0.07345123589038849, -0.07609347999095917, -0.024940555915236473, 0.02320181205868721, -0.006859388202428818, 0.01198...
0.038911
happens outside of {% data variables.product.github %}. For more information, see [AUTOTITLE](/rest/repos/repos#create-a-repository-dispatch-event). When you make a request to create a `repository\_dispatch` event, you must specify an `event\_type` to describe the activity type. By default, all `repository\_dispatch` a...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md
main
github-actions
[ -0.04121546819806099, 0.012098230421543121, -0.019896849989891052, 0.031196720898151398, -0.04054774343967438, -0.06742382049560547, 0.026039736345410347, 0.010586514137685299, 0.09082917869091034, 0.017136335372924805, 0.0031926908995956182, -0.06500063091516495, -0.004455896560102701, -0...
0.118166
{% data variables.product.prodname\_emu %} has not been deprovisioned by the IdP, and has only been removed as a member from a given organization in the enterprise, scheduled workflows will still run with that user set as the `actor`. > \* Similarly, for an enterprise without {% data variables.product.prodname\_emus %}...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md
main
github-actions
[ -0.03759361431002617, 0.050030417740345, -0.024194490164518356, -0.027418676763772964, 0.001909424434415996, 0.01596708409488201, 0.14256536960601807, 0.0423959344625473, -0.06156190112233162, -0.02442641369998455, 0.060189828276634216, 0.0022236842196434736, 0.06149156391620636, -0.004669...
0.090963
another workflow: ```yaml on: workflow\_call ``` ## `workflow\_dispatch` | Webhook event payload | Activity types | `GITHUB\_SHA` | `GITHUB\_REF` | | ------------------ | ------------ | ------------ | ------------------| | [workflow\_dispatch](/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow\_dispatch...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md
main
github-actions
[ -0.04819381982088089, -0.05002361908555031, -0.005565547849982977, 0.008910239674150944, 0.00868525356054306, -0.06787830591201782, 0.035265881568193436, -0.03896592929959297, 0.059566155076026917, -0.007139731198549271, 0.011541302315890789, -0.05418047308921814, -0.010733776725828648, -0...
0.086769
event is able to access secrets and write tokens, even if the previous workflow was not. This is useful in cases where the previous workflow is intentionally not privileged, but you need to take a privileged action in a later workflow. {% data reusables.actions.workflow-run-permissions-warning %} In this example, a wor...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md
main
github-actions
[ -0.00010005326475948095, -0.029399564489722252, 0.023106491193175316, 0.009418562985956669, 0.037307046353816986, -0.053513962775468826, -0.02570939064025879, -0.03620079532265663, 0.091020867228508, -0.054821744561195374, -0.022945493459701538, 0.003962394315749407, -0.011525429785251617, ...
0.064389
repo: context.repo.repo, artifact\_id: matchArtifact.id, archive\_format: 'zip', }); const fs = require('fs'); const path = require('path'); const temp = '{% raw %}${{ runner.temp }}{% endraw %}/artifacts'; if (!fs.existsSync(temp)){ fs.mkdirSync(temp); } fs.writeFileSync(path.join(temp, 'pr\_number.zip'), Buffer.from(...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md
main
github-actions
[ -0.08840765058994293, 0.07403510063886642, -0.08371007442474365, 0.06452938914299011, 0.04520951583981514, -0.07551538199186325, -0.016386210918426514, 0.07017587870359421, 0.019133038818836212, 0.07499980181455612, -0.01757637970149517, -0.007336522452533245, 0.013790084980428219, 0.00400...
0.0772
## Literals As part of an expression, you can use `boolean`, `null`, `number`, or `string` data types. | Data type | Literal value | |-----------|---------------| | `boolean` | `true` or `false` | | `null` | `null` | | `number` | Any number format supported by JSON. | | `string` | You don't need to enclose strings in `...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/expressions.md
main
github-actions
[ -0.016878919675946236, 0.028514133766293526, 0.010081702843308449, 0.0685504898428917, -0.022672655060887337, 0.018040016293525696, 0.014162490144371986, 0.06886132061481476, -0.05383655056357384, -0.004732716362923384, 0.01999986544251442, -0.042085207998752594, -0.003903341479599476, 0.0...
-0.019557
| | Object | Objects are not converted to a string | ### contains `contains( search, item )` Returns `true` if `search` contains `item`. If `search` is an array, this function returns `true` if the `item` is an element in the array. If `search` is a string, this function returns `true` if the `item` is a substring of `...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/expressions.md
main
github-actions
[ 0.018138697370886803, 0.05858512967824936, 0.03878108784556389, 0.05137486755847931, 0.06922372430562973, -0.025446079671382904, 0.1020098477602005, 0.009046891704201698, 0.020168226212263107, -0.0680072009563446, -0.020162835717201233, -0.05472074821591377, 0.039292581379413605, -0.002373...
0.091373
{% endraw %} #### Example returning a JSON data type This workflow uses `fromJSON` to convert environment variables from a string to a Boolean or integer. ```yaml copy name: print on: push env: continue: true time: 3 jobs: job1: runs-on: ubuntu-latest steps: - continue-on-error: {% raw %}${{ fromJSON(env.continue) }}{%...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/expressions.md
main
github-actions
[ -0.038939010351896286, 0.0610845573246479, -0.05445444583892822, 0.005964718293398619, 0.02449333295226097, -0.04698115214705467, -0.03795221820473671, -0.0009412349318154156, 0.014355391263961792, -0.05862855166196823, -0.02556961216032505, 0.025329412892460823, -0.050653114914894104, -0....
0.110597
steps: ... - name: The job has succeeded if: {% raw %}${{ success() }}{% endraw %} ``` ### always Causes the step to always execute, and returns `true`, even when canceled. The `always` expression is best used at the step level or on tasks that you expect to run even when a job is canceled. For example, you can use `al...
https://github.com/github/docs/blob/main/content/actions/reference/workflows-and-actions/expressions.md
main
github-actions
[ -0.07678099721670151, 0.05651886388659477, 0.008709837682545185, 0.039278294891119, 0.06204752251505852, -0.04252661392092705, -0.042642805725336075, -0.011929202824831009, 0.0249466672539711, -0.00038049681461416185, 0.007837551645934582, -0.014941247180104256, -0.0358581468462944, 0.0145...
0.071042
{% ifversion ghes %} {% data reusables.actions.enterprise-github-hosted-runners %} For reference information about larger runners, see [the {% data variables.product.prodname\_ghe\_cloud %} documentation](/enterprise-cloud@latest/actions/reference/larger-runners-reference). {% else %} ## Machine sizes for {% data varia...
https://github.com/github/docs/blob/main/content/actions/reference/runners/larger-runners.md
main
github-actions
[ 0.06559068709611893, 0.0041284626349806786, -0.0623839795589447, 0.06583517044782639, 0.021273937076330185, -0.009999489411711693, -0.05774131417274475, 0.06897543370723724, -0.05476432293653488, 0.06565389037132263, 0.022218378260731697, 0.0383773073554039, 0.003049340331926942, -0.072877...
0.057357
IP addresses from {% data variables.product.prodname\_dotcom %}'s IP address pool. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-githubs-ip-addresses). When enabled, instances of the {% data variables.actions.hosted\_runner %} will receive IP addresses from specific ra...
https://github.com/github/docs/blob/main/content/actions/reference/runners/larger-runners.md
main
github-actions
[ 0.026426605880260468, 0.0002508120669517666, -0.09836822748184204, 0.026730183511972427, 0.013118250295519829, 0.018953770399093628, 0.03531352058053017, 0.004176149144768715, -0.0916333869099617, 0.03408680483698845, 0.008854442276060581, -0.005097693298012018, 0.03682532161474228, -0.027...
0.048972
## Requirements for self-hosted runner machines You can use a machine as a self-hosted runner as long as it meets these requirements: \* You can install and run the self-hosted runner application on the machine. See [Supported operating systems](#supported-operating-systems) and [Supported processor architectures](#sup...
https://github.com/github/docs/blob/main/content/actions/reference/runners/self-hosted-runners.md
main
github-actions
[ 0.030973397195339203, -0.021709715947508812, -0.028290629386901855, -0.016938401386141777, -0.006997815798968077, -0.030734030529856682, -0.09358097612857819, 0.09068600088357925, -0.016166770830750465, -0.005341120529919863, -0.06641022861003876, -0.04983241856098175, -0.005979635752737522,...
0.191418
[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-support-for-actions-runner-controller). ### {% data variables.product.prodname\_actions %} Runner Scale Set Client The {% data variables.product.prodname\_actions %} Runner Scale Set Client is a standalone Go...
https://github.com/github/docs/blob/main/content/actions/reference/runners/self-hosted-runners.md
main
github-actions
[ -0.050224900245666504, -0.020661313086748123, -0.1015646830201149, 0.04445423185825348, -0.022876614704728127, -0.003846668405458331, 0.0009581460617482662, 0.11969495564699173, -0.08489525318145752, 0.019797423854470253, 0.03541545197367668, 0.006827911362051964, 0.020912358537316322, 0.0...
0.170694
[!NOTE] > If a job is labeled for a certain type of runner, but none matching that type are available, the job does not immediately fail at the time of queueing. Instead, the job will remain queued until the 24 hour timeout period expires. Alternatively, you can create ephemeral, just-in-time runners using the REST API...
https://github.com/github/docs/blob/main/content/actions/reference/runners/self-hosted-runners.md
main
github-actions
[ -0.025013785809278488, 0.018952200189232826, 0.018703458830714226, 0.036004360765218735, 0.03265830874443054, -0.06346378475427628, -0.11602866649627686, -0.03748415783047676, 0.021990017965435982, 0.0030546244233846664, -0.045935407280921936, 0.021945398300886154, -0.020347628742456436, -...
0.148674
the `manage\_runners:enterprise` scope. ## Communication Self-hosted runners connect to {% ifversion fpt or ghec %}{% data variables.product.github %}{% else %}{% data variables.location.product\_location\_enterprise %}{% endif %} to receive job assignments and download new versions of the runner application. {% data r...
https://github.com/github/docs/blob/main/content/actions/reference/runners/self-hosted-runners.md
main
github-actions
[ 0.004058201797306538, -0.028652342036366463, -0.04823240265250206, 0.06993516534566879, 0.030321110039949417, -0.03466401621699333, -0.05536285787820816, 0.018003951758146286, -0.039911508560180664, 0.03986459970474243, 0.004088988061994314, 0.025060631334781647, -0.03881710022687912, -0.0...
0.100626
and domain details for {% data variables.product.company\_short %} services. The `actions\_inbound` section of the API supports both fully qualified and wildcard domains. Fully qualified domains specify a complete domain name (e.g., `example.github.com`), while wildcard domains use a `\*` to represent multiple possible...
https://github.com/github/docs/blob/main/content/actions/reference/runners/self-hosted-runners.md
main
github-actions
[ -0.014158106409013271, -0.056392084807157516, -0.04913940280675888, -0.042365893721580505, 0.002615496050566435, -0.09020613878965378, -0.09933293610811234, 0.027560506016016006, 0.0039054069202393293, -0.023584425449371338, -0.06487242877483368, -0.003810579190030694, 0.050316642969846725, ...
0.073393
{% ifversion ghes %} {% data reusables.actions.enterprise-github-hosted-runners %} {% else %} ## Supported runners and hardware resources {% ifversion actions-hosted-runners %} Ranges of {% data variables.product.prodname\_dotcom %}-hosted runners are available for use in public and private repositories. For lists of a...
https://github.com/github/docs/blob/main/content/actions/reference/runners/github-hosted-runners.md
main
github-actions
[ 0.010907458141446114, -0.007450622506439686, -0.05168352276086807, 0.013566773384809494, 0.08297254145145416, 0.026901042088866234, -0.006014804821461439, 0.01650346629321575, -0.08556362986564636, 0.02786792628467083, 0.029509777203202248, -0.018796605989336967, 0.0023149950429797173, -0....
0.097734
documentation. ## IP addresses To get a list of IP address ranges that {% data variables.product.prodname\_actions %} uses for {% data variables.product.prodname\_dotcom %}-hosted runners, you can use the {% data variables.product.prodname\_dotcom %} REST API. For more information, see the `actions` key in the response...
https://github.com/github/docs/blob/main/content/actions/reference/runners/github-hosted-runners.md
main
github-actions
[ 0.022775549441576004, -0.0021885184105485678, -0.06462918221950531, 0.01795424334704876, 0.0026282952167093754, 0.03725063055753708, -0.000767576158978045, -0.017487594857811928, 0.008680818602442741, 0.07005829364061356, -0.01071628276258707, -0.002070845104753971, 0.05037769302725792, 0....
0.050893
## About custom transformers {% data variables.product.prodname\_actions\_importer %} offers the ability to extend its built-in mapping by creating custom transformers. Custom transformers can be used to: \* Convert items that {% data variables.product.prodname\_actions\_importer %} does not automatically convert, or m...
https://github.com/github/docs/blob/main/content/actions/reference/github-actions-importer/custom-transformers.md
main
github-actions
[ -0.019590949639678, -0.017170347273349762, -0.08202698081731796, 0.020878173410892487, -0.005984667222946882, 0.07358979433774948, 0.03400794789195061, 0.10784038156270981, -0.10196305811405182, -0.03647053614258766, 0.01561828050762415, -0.05798177793622017, 0.015044543892145157, 0.021930...
0.054494
npm run deploy ``` The `transform` method uses the identifier of the build step from your source CI/CD instance in an argument. In this example, the identifier is `buildJavaScriptLibrary`. You can also use comma-separated values to pass multiple identifiers to the `transform` method. For example, `transform "buildJavaS...
https://github.com/github/docs/blob/main/content/actions/reference/github-actions-importer/custom-transformers.md
main
github-actions
[ -0.06726725399494171, 0.031194260343909264, -0.0732216015458107, 0.003992070443928242, -0.015688767656683922, 0.02455119602382183, -0.01930488832294941, 0.12802428007125854, -0.08646096289157867, 0.05122290551662445, -0.0248268973082304, -0.03783716261386871, 0.06579307466745377, -0.014168...
0.131075
copy env "MONALISA", secret("OCTOCAT") ``` This will set up a reference to a secret named `OCTOCAT` in the transformed workflow. For the secret to work, you will need to create the secret in your GitHub repository. For more information, see [AUTOTITLE](/actions/security-guides/using-secrets-in-github-actions#creating-s...
https://github.com/github/docs/blob/main/content/actions/reference/github-actions-importer/custom-transformers.md
main
github-actions
[ -0.016842495650053024, -0.03356651961803436, -0.06492257118225098, 0.011565116234123707, -0.023089786991477013, -0.005880325101315975, -0.027060547843575478, -0.011203072033822536, -0.022407131269574165, -0.0006853539380244911, 0.005012695677578449, -0.08091732114553452, 0.03807614743709564,...
0.010338
This article provides general information for configuring {% data variables.product.prodname\_actions\_importer %}'s supplemental arguments and settings, such as optional parameters, path arguments, and network settings. ## Optional parameters {% data variables.product.prodname\_actions\_importer %} has several optiona...
https://github.com/github/docs/blob/main/content/actions/reference/github-actions-importer/supplemental-arguments-and-settings.md
main
github-actions
[ -0.010955636389553547, -0.014527681283652782, -0.06451421231031418, -0.05353470519185066, 0.05179700255393982, 0.021913621574640274, 0.05507985129952431, -0.0008714760188013315, -0.10339442640542984, 0.040063127875328064, 0.0375606007874012, -0.03441423177719116, 0.04654619097709656, 0.024...
0.044756
output similar to the following. ```shell Available feature flags: actions/cache (disabled): Control usage of actions/cache inside of workflows. Outputs a comment if not enabled. GitHub Enterprise Server >= ghes-3.5 required. composite-actions (enabled): Minimizes resulting workflow complexity through the use of compos...
https://github.com/github/docs/blob/main/content/actions/reference/github-actions-importer/supplemental-arguments-and-settings.md
main
github-actions
[ -0.024507323279976845, -0.07669276744127274, -0.0326090045273304, 0.01768222264945507, -0.020689403638243675, -0.05186747387051582, 0.009648694656789303, -0.05539855360984802, 0.0859975591301918, 0.003341239644214511, 0.0037996452301740646, 0.08137353509664536, 0.00069219566648826, -0.0285...
0.163363
{% data reusables.actions.enterprise-github-hosted-runners %} ## Overview {% data reusables.actions.about-actions %} You can create workflows that build and test every pull request to your repository, or deploy merged pull requests to production. {% data variables.product.prodname\_actions %} goes beyond just DevOps an...
https://github.com/github/docs/blob/main/content/actions/get-started/understand-github-actions.md
main
github-actions
[ -0.023757532238960266, -0.05200269818305969, -0.06395655870437622, 0.01329369843006134, 0.03071102872490883, 0.014409125782549381, 0.03921474516391754, 0.06965471804141998, -0.03242922201752663, 0.01848630979657173, 0.025339176878333092, -0.003494471311569214, -0.003526682034134865, -0.047...
0.176468
without any job dependencies and a packaging job that depends on those builds. The build jobs run in parallel, and once they complete successfully, the packaging job runs. For more information, see [AUTOTITLE](/actions/using-jobs). ### Actions An \*\*action\*\* is a pre-defined, reusable set of jobs or code that perfor...
https://github.com/github/docs/blob/main/content/actions/get-started/understand-github-actions.md
main
github-actions
[ -0.08734634518623352, -0.07116963714361191, 0.0024017200339585543, -0.010748639702796936, -0.0046870107762515545, -0.013748069293797016, 0.0539565309882164, -0.010894072242081165, -0.014832510612905025, 0.03859030455350876, 0.04280184954404831, -0.028932305052876472, 0.028739746659994125, ...
0.03221
{% data reusables.actions.enterprise-github-hosted-runners %} ## Introduction {% data reusables.actions.about-actions %} You can create workflows that run tests whenever you push a change to your repository, or that deploy merged pull requests to production. This quickstart guide shows you how to use the user interface...
https://github.com/github/docs/blob/main/content/actions/get-started/quickstart.md
main
github-actions
[ -0.034046098589897156, -0.05077540501952171, -0.04703570529818535, 0.018075399100780487, 0.024317637085914612, 0.04186684638261795, 0.04813305288553238, 0.04963885620236397, -0.037695370614528656, -0.019667010754346848, 0.009134209714829922, 0.043946120887994766, 0.0015678801573812962, -0....
0.079212
name: List files in the repository run: | ls {% raw %}${{ github.workspace }}{% endraw %} - run: echo "🍏 This job's status is {% raw %}${{ job.status }}{% endraw %}." ``` At this stage you don't need to understand the details of this workflow. For now, you can just copy and paste the contents into the file. After comp...
https://github.com/github/docs/blob/main/content/actions/get-started/quickstart.md
main
github-actions
[ -0.05738663673400879, 0.0025912802666425705, -0.08676005899906158, 0.020791368559002876, 0.04971138387918472, 0.02733610011637211, 0.07403746247291565, 0.06030413135886192, -0.04112563282251358, -0.02414250373840332, 0.0009757908992469311, -0.014869699254631996, -0.012737447395920753, -0.0...
0.096415
{% data reusables.actions.enterprise-github-hosted-runners %} ## About continuous deployment \_Continuous deployment\_ (CD) is the practice of using automation to publish and deploy software updates. As part of the typical CD process, the code is automatically built and tested before deployment. Continuous deployment i...
https://github.com/github/docs/blob/main/content/actions/get-started/continuous-deployment.md
main
github-actions
[ 0.0011175238760188222, -0.06563315540552139, -0.08105896413326263, 0.006175140384584665, -0.00796117726713419, -0.030535107478499413, 0.03580113500356674, 0.07034479826688766, -0.04786776006221771, 0.031544268131256104, 0.06237884238362312, 0.029089905321598053, 0.06087175011634827, -0.062...
0.156555
{% data variables.product.prodname\_marketplace %} offers both {% data variables.product.prodname\_actions %} and {% data variables.product.prodname\_github\_apps %}, each of which can be valuable automation and workflow tools. Understanding the differences and the benefits of each option will allow you to select the b...
https://github.com/github/docs/blob/main/content/actions/get-started/actions-vs-apps.md
main
github-actions
[ -0.02915421687066555, -0.02805553562939167, -0.0866612121462822, 0.009944381192326546, 0.016229815781116486, -0.01698540709912777, 0.04485483467578888, 0.11906775087118149, -0.06851713359355927, 0.037155307829380035, 0.0711822584271431, -0.009734700433909893, 0.059417981654405594, -0.02184...
0.124278
{% data reusables.actions.enterprise-github-hosted-runners %} ## About continuous integration Continuous integration (CI) is a software practice that requires frequently committing code to a shared repository. Committing code more often detects errors sooner and reduces the amount of code a developer needs to debug whe...
https://github.com/github/docs/blob/main/content/actions/get-started/continuous-integration.md
main
github-actions
[ -0.014725145883858204, -0.027116956189274788, -0.0852186307311058, 0.03584545850753784, -0.011209859512746334, -0.011111250147223473, 0.022091984748840332, 0.0771595686674118, -0.05058716982603073, 0.07097829878330231, 0.10185597836971283, -0.018296189606189728, 0.051500726491212845, -0.05...
0.115691
# Get started with Streamlit This Get Started guide explains how Streamlit works, how to install Streamlit on your preferred operating system, and how to create your first Streamlit app! helps you set up your development environment. Walk through installing Streamlit on Windows, macOS, or Linux. Alternatively, code rig...
https://github.com/streamlit/docs/blob/main/content/get-started/_index.md
main
streamlit
[ 0.022580554708838463, -0.05880012735724449, 0.00849241390824318, -0.000435048685176298, 0.0259956493973732, -0.04561040922999382, -0.03758152201771736, 0.06396059691905975, -0.0700942650437355, -0.0006590766715817153, -0.041780147701501846, -0.013706938363611698, 0.0056671747006475925, -0....
0.057812
# App model summary Now that you know a little more about all the individual pieces, let's close the loop and review how it works together: 1. Streamlit apps are Python scripts that run from top to bottom. 1. Every time a user opens a browser tab pointing to your app, the script is executed and a new session starts. 1....
https://github.com/streamlit/docs/blob/main/content/get-started/fundamentals/summary.md
main
streamlit
[ -0.06441134959459305, -0.029514716938138008, -0.03904278203845024, 0.012450513429939747, 0.02864050306379795, -0.05897727981209755, 0.03216009959578514, 0.04292917996644974, 0.03338877484202385, -0.012147565372288227, -0.037758029997348785, 0.04020005837082863, -0.004830094985663891, -0.02...
0.060603
# Basic concepts of Streamlit Working with Streamlit is simple. First you sprinkle a few Streamlit commands into a normal Python script, then you run it with `streamlit run`: ```bash streamlit run your\_script.py [-- script args] ``` As soon as you run the script as shown above, a local Streamlit server will spin up an...
https://github.com/streamlit/docs/blob/main/content/get-started/fundamentals/main-concepts.md
main
streamlit
[ -0.0012759091332554817, -0.02130376175045967, -0.05011698976159096, 0.02161877043545246, -0.017193378880620003, -0.06318557262420654, -0.012861472554504871, 0.08777694404125214, 0.023857848718762398, -0.044865865260362625, -0.05483587831258774, 0.019107302650809288, -0.014655275270342827, ...
0.034441
an input box, or clicking a button. Whenever a callback is passed to a widget via the `on\_change` (or `on\_click`) parameter, the callback will always run before the rest of your script. For details on the Callbacks API, please refer to our [Session State API Reference Guide](/develop/api-reference/caching-and-state/s...
https://github.com/streamlit/docs/blob/main/content/get-started/fundamentals/main-concepts.md
main
streamlit
[ -0.04936806112527847, 0.03323874995112419, -0.0324125811457634, 0.04126026853919029, -0.0022237305529415607, -0.050363704562187195, 0.04743756353855133, 0.011095555499196053, 0.0530836246907711, -0.025011157616972923, -0.07339517772197723, 0.08212055265903473, -0.04538210853934288, -0.0863...
0.06964
Python arrays. ```python import streamlit as st import numpy as np dataframe = np.random.randn(10, 20) st.dataframe(dataframe) ``` Let's expand on the first example using the Pandas `Styler` object to highlight some elements in the interactive table. ```python import streamlit as st import numpy as np import pandas as ...
https://github.com/streamlit/docs/blob/main/content/get-started/fundamentals/main-concepts.md
main
streamlit
[ 0.035562191158533096, -0.04928476735949516, -0.062054041773080826, -0.0072616287507116795, 0.028246205300092697, -0.04378797858953476, 0.011360714212059975, -0.046349912881851196, -0.04502847418189049, 0.013247332535684109, -0.030282950028777122, -0.0043024662882089615, 0.0033929022029042244...
-0.0127
through an array or data frame column. Let's use the `df` data frame we created earlier. ```python import streamlit as st import pandas as pd df = pd.DataFrame({ 'first column': [1, 2, 3, 4], 'second column': [10, 20, 30, 40] }) option = st.selectbox( 'Which number do you like best?', df['first column']) 'You selected:...
https://github.com/streamlit/docs/blob/main/content/get-started/fundamentals/main-concepts.md
main
streamlit
[ 0.011111536994576454, -0.020508281886577606, -0.07041864097118378, 0.023966489359736443, 0.03940162435173988, 0.007443604990839958, 0.00622494937852025, 0.029362300410866737, -0.013291153125464916, -0.016774268820881844, -0.002298916457220912, 0.048043154180049896, -0.03057459183037281, -0...
-0.079947
# Additional Streamlit features So you've read all about Streamlit's [Basic concepts](/get-started/fundamentals/main-concepts) and gotten a taste of caching and Session State in [Advanced concepts](/get-started/fundamentals/advanced-concepts). But what about the bells and whistles? Here's a quick look at some extra fea...
https://github.com/streamlit/docs/blob/main/content/get-started/fundamentals/additional-features.md
main
streamlit
[ 0.018023546785116196, -0.0413331463932991, 0.019625982269644737, 0.014762522652745247, 0.058170903474092484, 0.008465761318802834, 0.02460498735308647, 0.035119350999593735, -0.017600465565919876, 0.023304985836148262, -0.0497041754424572, 0.04946259781718254, -0.05110419541597366, -0.0010...
0.024577
the Streamlit library, try out custom components to extend Streamlit's built-in functionality. Explore and browse through popular, community-created components in the [Components gallery](https://streamlit.io/components). If you dabble in frontend development, you can build your own custom component with Streamlit's [c...
https://github.com/streamlit/docs/blob/main/content/get-started/fundamentals/additional-features.md
main
streamlit
[ 0.044413939118385315, -0.042358700186014175, -0.039666641503572464, 0.01678524725139141, 0.08181989192962646, -0.07024523615837097, -0.07012810558080673, 0.07104317843914032, 0.0007518447237089276, -0.010221337899565697, -0.020576361566781998, 0.03766685724258423, -0.027797238901257515, 0....
-0.023657
# Fundamental concepts Are you new to Streamlit and want the grand tour? If so, you're in the right place! Learn the fundamental concepts of Streamlit. How is a Streamlit app structured? How does it run? How does it magically get your data on a webpage? After you understand the rerun logic of Streamlit, learn how to ma...
https://github.com/streamlit/docs/blob/main/content/get-started/fundamentals/_index.md
main
streamlit
[ 0.03945082053542137, -0.07402706146240234, -0.01010117307305336, -0.011985904537141323, -0.06826198846101761, -0.05680994316935539, 0.026027968153357506, 0.06054003909230232, -0.09194596856832504, -0.028582248836755753, -0.04800434410572052, -0.01516118273139, -0.010206598788499832, -0.010...
0.022705
# Advanced concepts of Streamlit Now that you know how a Streamlit app runs and handles data, let's talk about being efficient. Caching allows you to save the output of a function so you can skip over it on rerun. Session State lets you save information for each user that is preserved between reruns. This not only allo...
https://github.com/streamlit/docs/blob/main/content/get-started/fundamentals/advanced-concepts.md
main
streamlit
[ -0.0278718713670969, 0.04763880744576454, -0.03420058265328407, 0.022231684997677803, -0.06459494680166245, -0.07300890237092972, 0.027517683804035187, 0.022202184423804283, 0.047852467745542526, 0.034883785992860794, -0.08389874547719955, 0.028529126197099686, -0.06724220514297485, -0.056...
0.09461
interacts with the app. If the user refreshes their browser page or reloads the URL to the app, their Session State resets and they begin again with a new session. ### Examples of using Session State Here's a simple app that counts the number of times the page has been run. Every time you click the button, the script w...
https://github.com/streamlit/docs/blob/main/content/get-started/fundamentals/advanced-concepts.md
main
streamlit
[ -0.07987101376056671, -0.020377129316329956, -0.06540793925523758, 0.03959866613149643, -0.04269067570567131, -0.009274984709918499, 0.009309615939855576, 0.029353780671954155, 0.07328512519598007, -0.0373103953897953, -0.061083752661943436, 0.010542739182710648, 0.016104498878121376, -0.0...
0.104532
be used to manipulate the widget. After you finish understanding the basics of Streamlit, check out our guide on [Widget behavior](/develop/concepts/architecture/widget-behavior) to dig in the details if you're interested. ## Connections As hinted above, you can use `@st.cache\_resource` to cache connections. This is t...
https://github.com/streamlit/docs/blob/main/content/get-started/fundamentals/advanced-concepts.md
main
streamlit
[ -0.01840963587164879, -0.03527092933654785, -0.10475553572177887, 0.01784523017704487, -0.0826825350522995, -0.06329137831926346, 0.08028319478034973, 0.040827568620443344, -0.0015152627602219582, -0.020433325320482254, -0.06999076157808304, 0.06501691043376923, 0.006124510895460844, -0.09...
-0.041425
# Create an app If you've made it this far, chances are you've [installed Streamlit](/get-started/installation) and run through the basics in [Basic concepts](/get-started/fundamentals/main-concepts) and [Advanced concepts](/get-started/fundamentals/advanced-concepts). If not, now is a good time to take a look. The eas...
https://github.com/streamlit/docs/blob/main/content/get-started/fundamentals/tutorials/create-an-app.md
main
streamlit
[ 0.006982341408729553, -0.05086807161569595, -0.04300791397690773, 0.05462024733424187, 0.04242734983563423, -0.03404317796230316, 0.004867535550147295, 0.07270772010087967, -0.018278179690241814, -0.0094676548615098, 0.009720616973936558, -0.014352725818753242, -0.02557416446506977, -0.055...
0.015897
that you want to load into the dataframe. 2. Now let's test the function and review the output. Below your function, add these lines: ```python # Create a text element and let the reader know the data is loading. data\_load\_state = st.text('Loading data...') # Load 10,000 rows of data into the dataframe. data = load\_...
https://github.com/streamlit/docs/blob/main/content/get-started/fundamentals/tutorials/create-an-app.md
main
streamlit
[ 0.008414790034294128, -0.004582976456731558, -0.04760359227657318, 0.029336590319871902, -0.0007236239034682512, -0.021705327555537224, -0.04826294258236885, 0.05535273998975754, 0.0005361259682103992, 0.0014441764215007424, -0.04257849231362343, 0.023514175787568092, -0.05529608204960823, ...
-0.023291
cache is really transformational. Whenever you have a long-running computation in your code, consider refactoring it so you can use `@st.cache\_data`, if possible. Please read [Caching](/develop/concepts/architecture/caching) for more details. Now that you know how caching with Streamlit works, let’s get back to the Ub...
https://github.com/streamlit/docs/blob/main/content/get-started/fundamentals/tutorials/create-an-app.md
main
streamlit
[ -0.0022403597831726074, 0.003446904942393303, -0.037627846002578735, 0.035887863487005234, -0.048617348074913025, -0.14429551362991333, -0.0017984373262152076, 0.03734675049781799, -0.030247414484620094, -0.011411329731345177, -0.07892800122499466, 0.018884781748056412, -0.05261808633804321,...
-0.008702
encourage you to take a look at the [`st.pydeck\_chart`](/develop/api-reference/charts/st.pydeck\_chart). ## Filter results with a slider In the last section, when you drew the map, the time used to filter results was hardcoded into the script, but what if we wanted to let a reader dynamically filter the data in real t...
https://github.com/streamlit/docs/blob/main/content/get-started/fundamentals/tutorials/create-an-app.md
main
streamlit
[ -0.011973878368735313, 0.0746411606669426, 0.004305523354560137, 0.027388444170355797, -0.0037561855278909206, -0.035495296120643616, -0.002028617076575756, 0.0019403448095545173, -0.01667197048664093, -0.08141747117042542, -0.0722399577498436, -0.0216485857963562, -0.04958505928516388, 0....
-0.049346
# Create a multipage app In [Additional features](/get-started/fundamentals/additional-features), we introduced multipage apps, including how to define pages, structure and run multipage apps, and navigate between pages in the user interface. You can read more details in our guide to [Multipage apps](/develop/concepts/...
https://github.com/streamlit/docs/blob/main/content/get-started/fundamentals/tutorials/create-a-multi-page-app.md
main
streamlit
[ -0.05194041132926941, -0.04978649318218231, -0.013564547523856163, -0.009712879545986652, 0.01743832789361477, -0.07408937066793442, -0.06344422698020935, 0.031431302428245544, -0.055838048458099365, -0.01714990846812725, -0.011668817140161991, 0.01604629121720791, -0.0031085878144949675, ...
0.022785
""" This demo shows how to use `st.write` to visualize Pandas DataFrames. (Data courtesy of the [UN Data Explorer](http://data.un.org/Explorer.aspx).) """ ) @st.cache\_data def get\_UN\_data(): AWS\_BUCKET\_URL = "http://streamlit-demo-data.s3-us-west-2.amazonaws.com" df = pd.read\_csv(AWS\_BUCKET\_URL + "/agri.csv.gz"...
https://github.com/streamlit/docs/blob/main/content/get-started/fundamentals/tutorials/create-a-multi-page-app.md
main
streamlit
[ 0.06979229301214218, 0.00031148118432611227, -0.014942271634936333, 0.004753788933157921, 0.10175099223852158, -0.05908560752868652, -0.040026113390922546, -0.0809730589389801, 0.05245567113161087, 0.047586631029844284, 0.01115744560956955, -0.09601099789142609, -0.049014728516340256, -0.0...
-0.086237
few things to remember here: 1. We can change the ordering of pages in our MPA by adding numbers to the beginning of each Python file. If we add a 1 to the front of our file name, Streamlit will put that file first in the list. 2. The name of each Streamlit app is determined by the file name, so to change the app name ...
https://github.com/streamlit/docs/blob/main/content/get-started/fundamentals/tutorials/create-a-multi-page-app.md
main
streamlit
[ -0.07391795516014099, -0.02151532657444477, -0.037612564861774445, -0.08412393182516098, -0.038098759949207306, -0.02723916806280613, -0.04025570675730705, 0.010210497304797173, -0.024252962321043015, 0.03520140051841736, -0.027917249128222466, 0.05068601295351982, 0.05028194561600685, 0.0...
-0.012483
($B)"} ) chart = ( alt.Chart(data) .mark\_area(opacity=0.3) .encode( x="year:T", y=alt.Y("Gross Agricultural Product ($B):Q", stack=None), color="Region:N", ) ) st.altair\_chart(chart, use\_container\_width=True) except URLError as e: st.error( """ \*\*This demo requires internet access.\*\* Connection error: %s """ % ...
https://github.com/streamlit/docs/blob/main/content/get-started/fundamentals/tutorials/create-a-multi-page-app.md
main
streamlit
[ 0.006301813293248415, -0.010259250178933144, 0.001379159395582974, -0.03515191748738289, 0.025411764159798622, -0.04768888279795647, -0.03396289423108101, 0.023701589554548264, -0.044368941336870193, -0.02179018035531044, 0.04527951404452324, -0.02591847814619541, 0.06284264475107193, -0.0...
-0.018733
# Install Streamlit using Anaconda Distribution This page walks you through installing Streamlit locally using Anaconda Distribution. At the end, you'll build a simple "Hello world" app and run it. You can read more about [Getting started with Anaconda Distribution](https://docs.anaconda.com/free/anaconda/getting-start...
https://github.com/streamlit/docs/blob/main/content/get-started/installation/anaconda-distribution.md
main
streamlit
[ 0.01570117101073265, -0.07377001643180847, -0.047394584864377975, -0.021732864901423454, 0.005612493958324194, -0.07245603948831558, -0.009737950749695301, 0.05527356266975403, -0.0889400839805603, 0.027840739116072655, -0.01673433557152748, -0.07750453799962997, -0.032813072204589844, 0.0...
0.110845
app will automatically open in your browser. If it doesn't for any reason, open your browser and go to the localhost address indicated in your terminal, typically `http://localhost:8501`. 25. Change `st.write` to `st.title` and save your file: ```python import streamlit as st st.title("Hello World") ``` 26. In your bro...
https://github.com/streamlit/docs/blob/main/content/get-started/installation/anaconda-distribution.md
main
streamlit
[ -0.012578087858855724, 0.012273148633539677, -0.005748860538005829, -0.00651735020801425, 0.04786297306418419, -0.09777980297803879, -0.07377598434686661, 0.047072604298591614, -0.02831941284239292, -0.00817248597741127, -0.04073379561305046, -0.000019650198737508617, 0.0016820504097267985, ...
0.024042
# Use Streamlit in Snowflake to code in a secure environment Snowflake is a single, global platform that powers the Data Cloud. If you want to use a secure platform with role-based access control, this is the option for you! This page walks you through creating a trial Snowflake account and building a "Hello world" app...
https://github.com/streamlit/docs/blob/main/content/get-started/installation/sis.md
main
streamlit
[ 0.018414217978715897, 0.0012216698378324509, -0.045484915375709534, 0.005275776144117117, 0.041509561240673065, 0.014605105854570866, -0.01094288844615221, 0.00822962075471878, 0.0038665346801280975, -0.014783444814383984, -0.07503412663936615, -0.031226683408021927, 0.013253276236355305, ...
-0.073338
![New database in your new trial Snowflake account](/images/get-started/SiS-2-databases.png) The databases in the above screenshot are as follows: - "SNOWFLAKE:" A built-in database that stores meta data for your account. - "SNOWFLAKE\_SAMPLE\_DATA:" A shared database with sample data. - "STREAMLIT\_DB:" Your new datab...
https://github.com/streamlit/docs/blob/main/content/get-started/installation/sis.md
main
streamlit
[ 0.054080717265605927, -0.09685425460338593, -0.0916442796587944, 0.016973527148365974, 0.07192487269639969, -0.02542518824338913, -0.015797074884176254, 0.057481955736875534, -0.022316932678222656, -0.012938844040036201, -0.022513946518301964, -0.06034152954816818, 0.04024149477481842, -0....
-0.020909
# Install Streamlit using command line This page will walk you through creating an environment with `venv` and installing Streamlit with `pip`. These are our recommended tools, but if you are familiar with others you can use your favorite ones too. At the end, you'll build a simple "Hello world" app and run it. If you ...
https://github.com/streamlit/docs/blob/main/content/get-started/installation/command-line.md
main
streamlit
[ -0.006862817797809839, -0.08582153916358948, -0.010053042322397232, -0.05950875207781792, 0.04235580563545227, -0.06526000052690506, -0.03144776076078415, 0.03441552817821503, -0.07870235294103622, -0.006479449104517698, -0.01926194317638874, -0.07093212753534317, -0.04247833043336868, 0.0...
0.011501
stop the Streamlit server, press `Ctrl+C` in the terminal. 15. When you're done using this environment, return to your normal shell by typing: ```bash deactivate ``` ## What's next? Read about our [Basic concepts](/get-started/fundamentals/main-concepts) to understand Streamlit's dataflow model.
https://github.com/streamlit/docs/blob/main/content/get-started/installation/command-line.md
main
streamlit
[ 0.06890962272882462, -0.0346028096973896, -0.03480719402432442, -0.003015537280589342, 0.007773680612444878, -0.07732837647199631, -0.004728822968900204, -0.03677278757095337, 0.03406233713030815, -0.021741483360528946, -0.06467746943235397, -0.02251732535660267, -0.06789492815732956, -0.0...
-0.008914
# Use Streamlit Playground in your browser The fastest way to try out Streamlit is to try out our Playground! Streamlit Playground runs in your browser. Just visit the Playground, and a \_limited\_ version of Streamlit loads as browser scripts. Enjoy the following conveniences: - Start playing with code right away, com...
https://github.com/streamlit/docs/blob/main/content/get-started/installation/streamlit-playground.md
main
streamlit
[ 0.017443783581256866, -0.0780521035194397, -0.024612508714199066, -0.0807465985417366, 0.07749272137880325, -0.07706423103809357, -0.050926584750413895, 0.0443122535943985, -0.09074275940656662, -0.018012013286352158, 0.03550177067518234, -0.056540776044130325, -0.028997523710131645, 0.057...
0.026412
# Use Community Cloud to develop with GitHub Codespaces To use GitHub Codespaces for Streamlit development, you need a properly configured `devcontainer.json` file to set up the environment. Fortunately, Streamlit Community Cloud is here to help! Although Community Cloud is primarily used to deploy and share apps with ...
https://github.com/streamlit/docs/blob/main/content/get-started/installation/cloud-quickstart.md
main
streamlit
[ -0.025099951773881912, -0.18707817792892456, -0.02613796293735504, 0.03527500480413437, 0.06108233332633972, -0.029797162860631943, -0.08099828660488129, -0.019210947677493095, -0.013890783302485943, 0.049732256680727005, 0.02469540759921074, -0.045762620866298676, -0.01840132474899292, 0....
-0.092807
changes. Your changes are committed locally in your codespace. 1. In the source control sidebar on the left, click "\*\**cached* 1 *arrow\_upward*\*\*" to push your commit to GitHub. 1. In the confirmation dialog, click "\*\*OK\*\*" to push commits to "origin/main." Your changes are now saved to your GitHub repository....
https://github.com/streamlit/docs/blob/main/content/get-started/installation/cloud-quickstart.md
main
streamlit
[ 0.03246394917368889, -0.13663657009601593, 0.023355180397629738, -0.007064589764922857, 0.10631338506937027, -0.03330805152654648, -0.03511407598853111, -0.06650971621274948, 0.025324087589979172, 0.09111133217811584, 0.03439042344689369, 0.010228065773844719, -0.054173532873392105, -0.021...
-0.071884
# Install Streamlit There are multiple ways to set up your development environment and install Streamlit. Developing locally with Python installed on your own computer is the most common scenario. Try a Streamlit Playground that runs in your browser — no installation required. (Note that this is not how Streamlit is me...
https://github.com/streamlit/docs/blob/main/content/get-started/installation/_index.md
main
streamlit
[ 0.01845044270157814, -0.0916924923658371, 0.00011384375829948112, -0.046409972012043, 0.03187626227736473, -0.07608271390199661, -0.038858506828546524, 0.026155197992920876, -0.06580974906682968, 0.020664649084210396, -0.008224033750593662, -0.0670323446393013, 0.0018773700576275587, 0.022...
-0.018461
# Documentation This directory contains docs, guides and resources to better use this repo. ## TOC \* [Datadog Agent](https://docs.datadoghq.com/agent/) user documentation. \* [Developer Guide](https://datadoghq.dev/datadog-agent/setup/): new users and contributors are encouraged to build the Datadog Agent themselves a...
https://github.com/DataDog/datadog-agent/blob/main/docs/README.md
main
datadog-agent
[ -0.029363658279180527, 0.0015515253180637956, -0.00037454129778780043, 0.025562552735209465, -0.013046168722212315, -0.013017590157687664, -0.058220915496349335, -0.0074005648493766785, -0.00657773669809103, 0.000981431338004768, 0.028757039457559586, -0.04886897653341293, 0.0884065106511116...
0.043579
## Create custom rules using the Assisted rule creator The \*\*Assisted rule creator\*\* option helps you create the Agent and dependent detection rules together, and ensures that the Agent rule is referenced in the detection rules. Using this tool is faster than the advanced method of creating the Agent and detection ...
https://github.com/DataDog/datadog-agent/blob/main/docs/cloud-workload-security/agent_expressions.md
main
datadog-agent
[ -0.09116921573877335, 0.04981943964958191, -0.041622184216976166, 0.014314391650259495, 0.08344155550003052, -0.06344582885503769, 0.05132335051894188, 0.0019654911011457443, 0.05158321559429169, -0.017967630177736282, 0.055562134832143784, 0.020706508308649063, 0.05269145220518112, 0.0203...
0.138254