-
Notifications
You must be signed in to change notification settings - Fork 83
/
mkdocs.yml
246 lines (237 loc) · 12.4 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
# Project information
site_name: Semaphore 2.0 Documentation
site_description: Semaphore 2.0 documentation
site_author: Semaphore Technologies doo
site_url: 'https://docs.semaphoreci.com'
# Repository
repo_name: semaphoreci/docs
repo_url: https://github.com/semaphoreci/docs
# Copyright
copyright: '© 2009-2024 Semaphore Technologies doo'
theme:
font:
text: 'Ubuntu'
code: 'Ubuntu Mono'
name: 'material'
custom_dir: template
logo: 'images/logo-white.svg'
favicon: 'images/favicon.ico'
feature:
tabs: true
palette:
primary: 'green'
accent: 'green'
extra_css:
- 'stylesheets/extra.css'
extra_javascript:
- 'javascript/extra.js'
extra:
social:
- type: 'github'
link: 'https://github.com/semaphoreci'
- type: 'twitter'
link: 'https://twitter.com/semaphoreci'
- type: 'linkedin'
link: 'https://www.linkedin.com/company/rendered-text'
markdown_extensions:
- attr_list
- md_in_html
- tables
- admonition
- attr_list
- md_in_html
- codehilite:
guess_lang: false
- toc:
permalink: '#'
- attr_list
nav:
- Welcome: index.md
- Guided Tour:
- Getting started: guided-tour/getting-started.md
- Essentials:
- "Key Concepts":
- Overview: essentials/concepts.md
- Pipelines: essentials/modeling-complex-workflows.md
- Triggers: essentials/project-workflow-trigger-options.md
- Tasks (formerly Schedulers): essentials/schedule-a-workflow-run.md
- Artifacts: essentials/artifacts.md
- Environment variables: essentials/environment-variables.md
- Secrets: essentials/using-secrets.md
- Tests: essentials/test-summary.md
- Flaky Tests: essentials/flaky-tests.md
- Debugging: essentials/debugging-with-ssh-access.md
- Optimizations:
- Caching: essentials/caching-dependencies-and-directories.md
- "Fail-fast": essentials/fail-fast-stop-running-tests-on-the-first-failure.md
- Auto-cancel: essentials/auto-cancel-previous-pipelines-on-a-new-push.md
- Skipping commits: essentials/skip-building-some-commits-with-ci-skip.md
- Prioritizing jobs: essentials/prioritization.md
- Monorepo workflows: essentials/building-monorepo-projects.md
- Job matrix: essentials/build-matrix.md
- Deployment:
- Deploying with promotions: essentials/deploying-with-promotions.md
- Parameterized promotions: essentials/parameterized-promotions.md
- Deployment targets: essentials/deployment-targets.md
- Pipeline queues: essentials/pipeline-queues.md
- Tag-triggered deployment: essentials/tag-triggered-deployment.md
- Deployment dashboards: essentials/deployment-dashboards.md
- Notifications:
- Slack notifications: essentials/slack-notifications.md
- Webhook notifications: essentials/webhook-notifications.md
- Status checks: essentials/configuring-status-checks.md
- Status Badges: essentials/status-badges.md
- Programming Languages:
- Android: programming-languages/android.md
- C: programming-languages/c.md
- C++: programming-languages/cpp.md
- Clojure: programming-languages/clojure.md
- Elixir: programming-languages/elixir.md
- Erlang: programming-languages/erlang.md
- Go: programming-languages/go.md
- Java: programming-languages/java.md
- JavaScript and Node.js: programming-languages/javascript-and-node-js.md
- PHP: programming-languages/php.md
- Python: programming-languages/python.md
- Ruby: programming-languages/ruby.md
- Rust: programming-languages/rust.md
- Scala: programming-languages/scala.md
- Swift: programming-languages/swift.md
- CI/CD Environment:
- Machine types: ci-cd-environment/machine-types.md
- Choosing between a VM and Docker-based environment: ci-cd-environment/choosing-between-a-vm-and-docker-based-environment.md
- Environment variables: ci-cd-environment/environment-variables.md
- Linux VM:
- Ubuntu 18.04 image: ci-cd-environment/ubuntu-18.04-image.md
- Ubuntu 20.04 image: ci-cd-environment/ubuntu-20.04-image.md
- Ubuntu 22.04 image: ci-cd-environment/ubuntu-22.04-image.md
- Ubuntu 22.04 ARM image: ci-cd-environment/ubuntu-22.04-arm-image.md
- Migrating to Ubuntu 20.04: ci-cd-environment/agent-migration-to-ubuntu2004.md
- "Selecting language versions": ci-cd-environment/sem-version-managing-language-versions-on-linux.md
- "Starting databases": ci-cd-environment/sem-service-managing-databases-and-services-on-linux.md
- Configuring database access: ci-cd-environment/configuring-database-access.md
- Nested virtualization: ci-cd-environment/nested-virtualization.md
- Docker:
- Docker-based CI/CD environment: ci-cd-environment/custom-ci-cd-environment-with-docker.md
- Docker layer caching: ci-cd-environment/docker-layer-caching.md
- Working with Docker: ci-cd-environment/working-with-docker.md
- DockerHub authentication: ci-cd-environment/docker-authentication.md
- Semaphore Container Registry: ci-cd-environment/semaphore-registry-images.md
- "iOS/macOS":
- macOS Xcode 14 image: ci-cd-environment/macos-xcode-14-image.md
- macOS Xcode 15 image: ci-cd-environment/macos-xcode-15-image.md
- macOS Xcode 16 image: ci-cd-environment/macos-xcode-16-image.md
- Android:
- Docker images: ci-cd-environment/android-images.md
- Flutter example: ci-cd-environment/flutter.md
- Self-hosted agents:
- Overview: ci-cd-environment/self-hosted-agents-overview.md
- Self-hosted agent types: ci-cd-environment/self-hosted-agent-types.md
- Installation: ci-cd-environment/install-self-hosted-agent.md
- Configuration: ci-cd-environment/configure-self-hosted-agent.md
- Job environment: ci-cd-environment/job-environment.md
- AWS support: ci-cd-environment/aws-support.md
- Kubernetes support: ci-cd-environment/kubernetes-support.md
- S3-based caching: ci-cd-environment/set-up-caching-on-aws-s3.md
- Examples:
- Tutorials and example projects: examples/tutorials-and-example-projects.md
- External Integrations:
- Cypress: examples/integrations/cypress.md
- BrowserStack: examples/integrations/browserstack.md
- Continuous Integration:
- Rails continuous integration: examples/rails-continuous-integration.md
- Node.js and TypeScript continuous integration: examples/node-js-and-typescript-continuous-integration.md
- iOS continuous integration with Xcode: examples/ios-continuous-integration-with-xcode.md
- CI/CD for microservices on Kubernetes: examples/ci-cd-for-microservices-on-kubernetes.md
- Using Docker Compose in CI: examples/using-docker-compose-in-ci.md
- Laravel PHP continuous integration: examples/laravel-php-continuous-integration.md
- Django continuous integration: examples/django-continuous-integration.md
- Java Spring continuous integration: examples/java-spring-continuous-integration.md
- Download and cache a custom file: examples/download-and-cache-a-custom-file.md
- Code signing for iOS projects: examples/code-signing-for-ios-projects.md
- Golang continuous integration: examples/golang-continuous-integration.md
- Elixir Phoenix continuous integration: examples/elixir-phoenix-continuous-integration.md
- Scala Play continuous integration: examples/scala-play-continuous-integration.md
- Configuring parallel tests with Code Climate: examples/configuring-parallel-tests-with-code-climate.md
- Clojure Luminus CI/CD: examples/clojure-luminus-ci-cd.md
- Change-based execution for monorepos: examples/change-based-execution-for-monorepos.md
- Using Terraform with Google Cloud: examples/using-terraform-with-google-cloud.md
- Using private dependencies: essentials/using-private-dependencies.md
- Releasing semantic versions: essentials/releasing-semantic-versions.md
- Estimating cloud costs with Infracost: examples/estimating-cloud-costs-with-infracost.md
- Deployment:
- AWS Elastic Beanstalk: examples/deployment-to-aws-elastic-beanstalk.md
- Deploying to DigitalOcean: examples/deploy-to-digitalocean.md
- Deploying with Git Deploy: examples/deploying_with_git_deploy.md
- Zeit Now continuous deployment: examples/zeit-now-continuous-deployment.md
- Publishing Docker images on DockerHub: examples/publishing-docker-images-on-dockerhub.md
- Pushing Docker images to AWS Elastic Container Registry (ECR): examples/pushing-docker-images-to-aws-elastic-container-registry-ecr.md
- Heroku deployment: examples/heroku-deployment.md
- Continuous deployment of a static website: examples/continuous-deployment-of-a-static-website.md
- Pushing Docker images to Google Container Registry (GCR): examples/pushing-docker-images-to-google-container-registry-gcr.md
- Google Cloud run continuous deployment: examples/google-cloud-run-continuous-deployment.md
- Deploy to DigitalOcean Kubernetes: examples/deploy-to-digitalocean.md
- Netlify continuous deployment: examples/netlify-continuous-deployment.md
- Deployment to AWS Elastic Beanstalk: examples/deployment-to-aws-elastic-beanstalk.md
- HockeyApp iOS app distribution: examples/hockeyapp-ios-app-distribution.md
- TestFlight iOS app distribution: examples/testflight-ios-app-distribution.md
- Reference:
- Pipeline YAML: reference/pipeline-yaml-reference.md
- Pipeline Initialization: reference/pipeline-initialization.md
- When Conditions: reference/conditions-reference.md
- Secrets YAML: reference/secrets-yaml-reference.md
- Projects YAML: reference/projects-yaml-reference.md
- Dashboards YAML: reference/dashboards-yaml-reference.md
- Jobs YAML: reference/jobs-yaml-reference.md
- Notifications YAML: reference/notifications-yaml-reference.md
- Deployment Targets YAML: reference/deployment-targets-yaml-reference.md
- Agent Types YAML: reference/agent-types-yaml-reference.md
- Sem CLI: reference/sem-command-line-tool.md
- Artifact CLI: reference/artifact-cli-reference.md
- Sem-context CLI: reference/sem-context-reference.md
- Artifact Retention Policy: reference/artifact-retention-policies.md
- Test results CLI: reference/test-results-cli-reference.md
- API: reference/api-v1alpha.md
- Toolbox: reference/toolbox-reference.md
- Quotas and limits: reference/quotas-and-limits.md
- Semaphore Changelog: reference/semaphore-changelog.md
- Glossary: reference/glossary.md
- Account Management:
- Billing Overview: account-management/billing-overview.md
- Billing FAQ: account-management/billing-faq.md
- Organizations: account-management/organizations.md
- Permission levels: account-management/permission-levels.md
- Connecting GitHub with Semaphore: account-management/connecting-github-and-semaphore.md
- Working with GitHub SSO: account-management/working-with-github-sso.md
- Connecting Bitbucket with Semaphore: account-management/connecting-bitbucket-and-semaphore.md
- Security:
- "Audit logs":
- Audit logs: security/audit-logs.md
- Audit logs exporting: security/audit-logs-exporting.md
- Audit Events reference: security/audit-events-reference.md
- "OpenID Connect":
- Overview: security/open-id-connect.md
- Setup with AWS: security/open-id-connect-aws.md
- Setup with GCP: security/open-id-connect-gcloud.md
- Setup with Vault: security/open-id-connect-vault.md
- Pre-flight checks: security/configuring-pre-flight-checks.md
- "Okta integration":
- Overview: security/okta/overview.md
- Installation: security/okta/installation.md
- "User authorization":
- RBAC overview: security/rbac-authorization.md
- Default roles: security/default-roles.md
- Repository-to-role mappings: security/repository-to-role-mappings.md
- User Groups: security/groups/groups.md
- Score:
- Insights: score/project-insights.md
- Custom dashboards: score/custom-dashboards.md
- Organization Health: score/organization-health.md
- FAQ:
- FAQ: faq/faq.md
- Managing projects: faq/managing-projects.md
- Migration guides:
- Migration guide for Semaphore Classic users: faq/migration-guide-for-semaphore-classic-users.md
- Migrating from GitHub Actions to Semaphore: faq/migrating-from-github-actions-to-semaphore.md
- Migrating from Jenkins to Semaphore: faq/migrating-from-jenkins-to-semaphore.md
- Migrating from Travis CI to Semaphore: faq/migrating-from-travis-ci-to-semaphore.md