Search.setIndex({docnames:["_api/airflow/providers/github/hooks/github/index","_api/airflow/providers/github/hooks/index","_api/airflow/providers/github/index","_api/airflow/providers/github/operators/github/index","_api/airflow/providers/github/operators/index","_api/airflow/providers/github/sensors/github/index","_api/airflow/providers/github/sensors/index","_api/tests/system/providers/github/example_github/index","_api/tests/system/providers/github/index","commits","connections/github","index","installing-providers-from-sources","operators/index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":5,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,sphinx:56},filenames:["_api/airflow/providers/github/hooks/github/index.rst","_api/airflow/providers/github/hooks/index.rst","_api/airflow/providers/github/index.rst","_api/airflow/providers/github/operators/github/index.rst","_api/airflow/providers/github/operators/index.rst","_api/airflow/providers/github/sensors/github/index.rst","_api/airflow/providers/github/sensors/index.rst","_api/tests/system/providers/github/example_github/index.rst","_api/tests/system/providers/github/index.rst","commits.rst","connections/github.rst","index.rst","installing-providers-from-sources.rst","operators/index.rst"],objects:{"airflow.providers":[[2,0,0,"-","github"]],"airflow.providers.github":[[1,0,0,"-","hooks"],[4,0,0,"-","operators"],[6,0,0,"-","sensors"]],"airflow.providers.github.hooks":[[0,0,0,"-","github"]],"airflow.providers.github.hooks.github":[[0,1,1,"","GithubHook"]],"airflow.providers.github.hooks.github.GithubHook":[[0,2,1,"","conn_name_attr"],[0,2,1,"","conn_type"],[0,2,1,"","default_conn_name"],[0,3,1,"","get_conn"],[0,3,1,"","get_ui_field_behaviour"],[0,2,1,"","hook_name"]],"airflow.providers.github.operators":[[3,0,0,"-","github"]],"airflow.providers.github.operators.github":[[3,1,1,"","GithubOperator"]],"airflow.providers.github.operators.github.GithubOperator":[[3,3,1,"","execute"],[3,2,1,"","template_fields"]],"airflow.providers.github.sensors":[[5,0,0,"-","github"]],"airflow.providers.github.sensors.github":[[5,1,1,"","BaseGithubRepositorySensor"],[5,1,1,"","GithubSensor"],[5,1,1,"","GithubTagSensor"]],"airflow.providers.github.sensors.github.BaseGithubRepositorySensor":[[5,3,1,"","poke"]],"airflow.providers.github.sensors.github.GithubSensor":[[5,3,1,"","poke"]],"airflow.providers.github.sensors.github.GithubTagSensor":[[5,3,1,"","poke"],[5,3,1,"","tag_checker"],[5,2,1,"","template_fields"]],"tests.system.providers":[[8,0,0,"-","github"]],"tests.system.providers.github":[[7,0,0,"-","example_github"]],"tests.system.providers.github.example_github":[[7,4,1,"","DAG_ID"],[7,4,1,"","ENV_ID"],[7,4,1,"","tag_sensor"],[7,4,1,"","test_run"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","attribute","Python attribute"],"3":["py","method","Python method"],"4":["py","data","Python data"]},objtypes:{"0":"py:module","1":"py:class","2":"py:attribute","3":"py:method","4":"py:data"},terms:{"0":[0,1,2,3,4,5,6,7,8,10,12,13],"01":9,"02":9,"03":9,"04":9,"05":9,"06":9,"07":9,"08":9,"0a3ff43d41":9,"10":[9,11,13],"11":[9,12],"12":[9,12],"14":9,"16adc035b1":9,"18":9,"2":[0,1,2,3,4,5,6,7,8,10,12,13],"2021":12,"2022":9,"21076":9,"21398":9,"22":9,"22056":9,"22226":9,"22382":11,"22383":9,"22446":9,"22884":9,"23":9,"23104":9,"23631":9,"23764":9,"24134":9,"24214":[9,11],"24231":9,"24292":9,"28":9,"4":[0,1,2,3,4,5,6,7,8,9,10,11,12,13],"406f":12,"49":12,"4a85370ca9":9,"4d3a":12,"512":12,"54":12,"5c6e":12,"5d23fbe2bb":9,"5f6d7d202e":9,"60":13,"6674":12,"6933022e94":9,"717a7588bc":9,"75c60923e0":9,"82d5f7cdb7":9,"8b6b0848a3":9,"8ec4":12,"boolean":5,"class":11,"do":12,"function":[0,3,5,13],"import":12,"new":[0,9],"return":[0,5,13],"static":0,"try":13,"while":5,By:12,For:[3,9,12],If:12,It:12,The:[10,12],There:12,To:12,__init__:[9,11],about:12,abov:12,access:10,account:10,achiev:13,act:5,action:3,ad:[9,11],add:[9,11],aeabe994b3:9,airflow:[12,13],airflowexcept:13,aka:12,all:[11,13],all_tag:13,allow:0,alreadi:12,also:[12,13],an:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],ani:[5,12,13],apach:[5,12,13],apache_airflow_providers_github:12,api:[3,10,11],ar:[11,12],arg:0,asc:12,authent:10,avail:[11,12],ba4b:12,base:[0,3,5],basegithubrepositorysensor:[5,13],basehook:0,baseoper:3,basesensoroper:5,bash:12,behaviour:0,belong:12,below:[11,12],bin:12,binari:12,blob:11,bool:13,brees:9,bst:12,bugfix:9,build:[9,12,13],call:3,callabl:[3,5,13],can:[5,10,11,12,13],cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f:12,cde1:12,certif:12,certifi:12,chang:[5,9],changelog:[9,11],chapter:12,check:[5,9,12],checksum:12,choos:12,classifi:[9,11],client:[0,13],cloud:10,code:12,com:[3,10,11,12],commit:9,conn_name_attr:0,conn_typ:0,connect:[0,3,5,11],contain:12,context:[3,5],correct:12,creat:[3,10,12],creation:[5,13],curl:12,custom:0,d7dbfb7e26:9,d7de:12,d:12,dag:[9,11],dag_id:7,data:10,def:13,default_conn_nam:0,defin:[3,5],dep:12,deploy:10,deriv:[3,5],describ:12,descript:9,design:[3,9],dest:12,detail:[9,11,12],dev0:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],dict:[3,5],dictionari:3,diff:12,differ:12,directli:13,directori:12,distribut:12,doc:[9,10],docstr:9,document:9,doubl:9,down:12,download:12,drop:12,e08a:12,e:13,ecf4:12,echo:12,en:10,enterpris:[0,10],env_id:7,error:[9,13],essenti:12,ex:5,exampl:[9,11,12,13],example_github:[8,13],example_github_oper:7,example_sensor:13,example_tag_sensor:13,except:13,execut:[3,5,13],exist:[5,11],experiment:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],explain:11,f5b96315fe:9,f:13,fail:13,featur:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],feb:9,field:0,file:12,fingerprint:12,fix:9,folder:12,follow:[10,12,13],format:10,foundat:12,framework:11,from:[3,5,11,13],full:5,full_name_or_id:13,fulli:5,further:[3,13],get:12,get_conn:0,get_repo:13,get_tag:13,get_template_context:3,get_ui_field_behaviour:0,get_us:13,github:[12,13],github_conn_id:[0,3,5],github_default:[0,3,5],github_error:13,github_list_repo:13,github_method:[3,13],github_method_arg:[3,13],github_sensor:13,githubexcept:13,githubhook:0,githuboper:[3,9,11,13],githubsensor:[5,9,11,13],githubtagsensor:[5,13],gmail:12,good:12,gpg:12,guid:[3,12],gz:12,high:9,hook:2,hook_nam:0,host:10,hostnam:[0,10],how:[3,12],http:[3,10,11,12],i:12,id:[0,12],ignor:13,imag:9,implement:13,includ:9,indic:12,info:13,inform:[3,9],initi:[0,11],install_requir:11,instruct:12,interact:[0,3],issuer:12,its:5,jinja:3,ka:12,kaxil:12,kaxilnaik:12,keep:10,kei:12,know:12,kwarg:[0,3,5],l:12,la:12,lambda:13,latest:[9,10],left:12,level:[5,9,13],like:13,link:12,list:[9,11,13],list_repo_tag:13,local:12,log:13,look:3,ls:12,made:12,mai:9,main:[3,9,11,12],manag:12,march:9,match:12,md:11,method:[3,5,13],method_nam:[5,13],method_param:[5,13],migrat:9,min:9,minimum:11,mirror:12,misc:13,mistakenli:11,mktemp:12,model:3,monitor:5,more:3,most:12,mypi:9,naik:12,name:[3,5,13],none:[3,5,12,13],o:12,offici:12,onc:12,one:12,onli:11,oper:[2,11],option:[3,5,10,13],org:12,origin:12,overrid:5,own:13,owner:12,package_nam:12,package_vers:12,page:12,param:9,paramet:[0,3,5],pass:13,perform:[0,3],permiss:10,person:10,pgp:12,pgpk:12,pgpv:12,pip:[11,12],pleas:12,poke:5,poke_interv:13,polici:11,pre:[3,5,9],prepar:9,previou:12,primari:12,process:[3,13],provid:[10,12,13],provider_download_dir:12,pull:9,py3:12,py:13,pygithub:[3,5,11,13],pypi:11,python:[3,11,12],qualifi:5,rais:13,readm:11,recommend:12,refer:[0,3,5],releas:[9,11],relev:12,remov:[9,11,12],render:3,repo:[5,13],repositori:[5,11,13],repository_nam:[5,13],requir:[3,10],respons:[3,5],result:13,result_processor:[3,5,13],retriev:0,rsa:12,run:12,s:[9,12],same:3,sat:12,script:12,sdist:12,sdk:3,secur:10,see:[9,11],select:12,self:[0,3,5,12],sensor:[2,11],sep:12,server:12,sha512:12,sha:12,shasum:12,should:[5,10,12],sign:12,signatur:12,similar:13,softwar:12,sourc:[0,3,5,7,11,13],specif:9,specifi:10,step:12,str:[0,3,5,13],string:10,subject:9,sum:12,support:11,system:13,tag:[5,13],tag_check:[5,13],tag_nam:[5,13],tag_sensor:[7,13],take:3,tar:12,task_id:13,templat:3,template_field:[3,5],temporari:12,test:13,test_run:7,thi:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],those:12,timeout:13,token:[0,10],top:[11,12,13],trove:11,trust:12,type:[9,10,11,13],unknown:12,updat:9,url:10,us:[3,9,10,11,12,13],user:[12,13],v1:13,v3:10,valid:12,verifi:9,version:[9,11,12],via:[11,12],wait:13,want:12,warn:12,well:12,when:3,which:5,whl:12,why:12,worri:12,x:13,you:[11,12,13],your:[10,13]},titles:["<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.github.hooks.github</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.github.hooks</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.github</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.github.operators.github</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.github.operators</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.github.sensors.github</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.github.sensors</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.github.example_github</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.github</span></code>","Package apache-airflow-providers-github","GitHub Connection","<code class=\"docutils literal notranslate\"><span class=\"pre\">apache-airflow-providers-github</span></code>","Installing from sources","Operators"],titleterms:{"0":[9,11],"1":[9,11],"2":[9,11],"3":[9,11],"break":11,"class":[0,3,5],airflow:[0,1,2,3,4,5,6,9,11],apach:[9,11],bug:11,chang:11,commit:11,configur:10,connect:10,content:[0,3,5,7,11],example_github:7,fix:11,from:12,github:[0,1,2,3,4,5,6,7,8,9,10,11],guid:11,hook:[0,1],instal:[11,12],integr:12,misc:11,modul:[0,3,5,7],oper:[3,4,13],packag:[9,11,12],provid:[0,1,2,3,4,5,6,7,8,9,11],pypi:12,refer:11,releas:12,requir:11,resourc:11,sensor:[5,6,13],sourc:12,submodul:[1,4,6,8],subpackag:2,system:[7,8],test:[7,8],verifi:12}})