Skip to content

Commit 8e0949e

Browse files
authored
docs: add v1.3 pages for CE (#381)
## 📝 Description This PR adds v1.3 pages for CE. In addition, it adds the following small changes: - note on exporting audit logs in CSV format (#353) - note about inviting GitHub and BitBucket users (#354) - note about GitHub users being case-sensitive (#355) - note about GitHub PRs stuck due to renamed pipelines (#360) ## ✅ Checklist - [X] I have tested this change - [ ] This change requires documentation update
1 parent f698885 commit 8e0949e

File tree

484 files changed

+21171
-25
lines changed

Some content is hidden

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

484 files changed

+21171
-25
lines changed

docs/docs/getting-started/faq.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -419,6 +419,10 @@ If you cannot authenticate, you can use other third-party Docker registries such
419419
420420
:::
421421
422+
### Pull request on GitHub is stuck
423+
424+
If you have a pull request stuck when using GitHub, check if you have renamed the pipeline recently. If you did, see how to [fix stuck PRs on GitHub](../using-semaphore/connect-github#stuck-pr)
425+
422426
423427
## Project
424428

docs/docs/using-semaphore/connect-github.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,34 @@ This means that Semaphore can't fetch the `.semaphore/semaphore.yml` file from t
178178
1. **The file doesn't exist on your repository**: double check to make sure that the Semaphore YAML file actually exists
179179
2. **Repository is disconnected from Semaphore**: follow the steps [previously described](#reconnect)
180180

181+
### This pull request is still a work in progress {#stuck-pr}
182+
183+
Renaming the pipeline in Semaphore can cause GitHub pull requests to be stuck, as GitHub expects the old name to report back the status.
184+
185+
For instance, renaming the `semaphore.yml` pipeline file from:
186+
187+
```yaml
188+
version: v1.0
189+
name: Rails 7
190+
```
191+
192+
To something like:
193+
194+
```yaml
195+
version: v1.0
196+
name: Rails 8
197+
```
198+
199+
Can cause any pending pull requests on GitHub to wait forever.
200+
201+
To solve the issue, follow these steps:
202+
203+
1. Go to your GitHub repository.
204+
2. Navigate to **Settings** > **Branches**,
205+
3. Under **Branch Protection Rules**, find the rule for your default or protected branch and press **Edit**
206+
4. In the **Require status checks to pass before merging** section, remove the outdated check, e.g. `ci/semaphoreci/push: old-name`) and add the new one if needed, e.g. `ci/semaphoreci/push: new-name`
207+
5. Save the changes.
208+
181209
## Connect with GitHub SAML
182210

183211
Semaphore supports repositories hosted on GitHub with SAML single sign-on (SSO). This GitHub feature is available in the GitHub Enterprise Cloud offering.

docs/docs/using-semaphore/organizations.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,8 @@ To invite a user to your organization, press the **Add people** button:
8080
<Steps>
8181

8282
1. Select one of the available tabs
83-
- Type the user's handle, e.g. `TomFern`, or select the user from the list.
83+
84+
- Type the user's handle, e.g. `TomFern`, or select the user from the list. Usernames are case-sensitive and all characters are considered. Ensure the handle is entered accurately to avoid errors.
8485
- If you don't see the user in the list. Ensure they have repository access in **GitHub** or **BitBucket** for at least one project in your organization
8586

8687
![Invite users](./img/invite-users.jpg)
@@ -91,6 +92,14 @@ To invite a user to your organization, press the **Add people** button:
9192

9293
</Steps>
9394

95+
:::info
96+
97+
If you see an error with the message "error finding USERNAME: 401", it's likely that the your Semaphore account, as the inviter, is no longer linked to GitHub or BitBucket.
98+
99+
To fix the issue, reconnect your account by granting access again via [GitHub](./connect-github-oauth#connect-oauth) or [Bitbucket](./connect-bitbucket#grant-bb). This should restore your ability to send invitations.
100+
101+
:::
102+
94103
### How to remove users {#remove-users}
95104
96105
Users can only be removed from the organization when they don't own any projects. You must [transfer the ownership](./projects#owner-change) of all the user's projects before they can be removed from the organization.
@@ -333,6 +342,8 @@ To configure streaming to an S3-compatible bucket, press the **Configure Streami
333342

334343
Audit logs are streamed to the bucket once per day.
335344

345+
Large audit logs may cause errors when exporting to CSV. In this case, consider setting up an S3-compatible bucket instead of using CSV as the export medium.
346+
336347
:::
337348

338349
## Organization queues {#queue}

docs/docusaurus.config.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,14 @@ const config = {
6565
banner: "none",
6666
},
6767
"CE": {
68-
label: 'Community Edition v1.2',
68+
label: 'Community Edition v1.3',
6969
path: 'CE',
7070
banner: "none"
7171
},
72+
"CE-1.2": {
73+
label: 'Community Edition v1.2',
74+
path: 'CE-1.2',
75+
},
7276
"CE-1.1": {
7377
label: 'Community Edition v1.1',
7478
path: 'CE-1.1',
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Get Started",
3+
"position": 1,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Guided tour and the basics of Continuous Integration and Delivery (CI/CD)"
7+
}
8+
}
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
description: About Semaphore
3+
---
4+
5+
# About Semaphore
6+
7+
Semaphore is [Continuous Integration and Delivery](https://semaphore.io/continuous-integration) (CI) platform that's fast, easy to use, and incredibly scalable.
8+
9+
## Semaphore editions {#editions}
10+
11+
Semaphore comes in two editions:
12+
13+
- **[Semaphore Cloud](/getting-started/about-semaphore)**: is a cloud-based, fully-managed CI-as-a-Service platform. Meant for individuals and companies that don't wish to maintain a CI/CD system. Head to [semaphoreci.com](https://semaphore.io) to access Semaphore Cloud
14+
- **[Semaphore CE](/CE/getting-started/install)**: is the free and open-source Community Edition of Semaphore. Meant for anyone that wishes to host and manage their own CI/CD architecture.
15+
- **On-premise (Enterprise Edition)**: fully-featured Semaphore that can run behind a firewall using your infrastructure
16+
17+
See the [feature comparison](./features) to decide which edition of Semaphore is best for you.
18+
19+
## What is CI/CD?
20+
21+
Continuous Integration (CI) is an automated process of regularly merging code changes, running tests, and providing rapid feedback to developers.
22+
23+
CI enables developers to frequently merge code changes, automatically test them, and detect integration issues early, leading to faster development cycles and higher-quality software.
24+
25+
![CI Workflow](./tour/img/ci-workflow.jpg)
26+
27+
Continuous Delivery and Continuous Deployment extend this process by providing a package you can release and deploy to the world. The whole thing is automated and can be set up to not need human intervention. No more stressing over deployment or releases!
28+
29+
![CD Workflow](./tour/img/cd-workflow.jpg)
30+
31+
## Where to go next?
32+
33+
If you want to give Semaphore Cloud, head to the [Guided Tour](./guided-tour). If you prefer to self-host, see the [Community Edition installation guide](./install).
34+
35+
You can find the complete Semaphore handbook in the [Using Semaphore](../using-semaphore/jobs) section.
36+
37+
And if you want to dive deep into Semaphore's inner workings check out the [Reference pages](../reference/semaphore-cli) and the [Semaphore API reference](../reference/api).
38+
39+
<!-- new api: [API documentation](../openapi-spec/semaphore-public-api.info.mdx) --->
40+
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
description: Semaphore change log for Semaphore CE.
3+
---
4+
5+
# Change Log
6+
7+
Thank you for using Semaphore!
8+
9+
This page shows changes in all Semaphore CE versions.
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Experiments Sandbox (dev build)
2+
3+
## Steps
4+
5+
6+
import Steps from '@site/src/components/Steps';
7+
8+
```js
9+
import Steps from '@site/src/components/Steps';
10+
```
11+
12+
<Steps>
13+
14+
15+
1. Import the component into your MDX file:
16+
17+
```js
18+
import Steps from '@site/src/components/Steps';
19+
```
20+
2. Step 2
21+
22+
- subpoint
23+
- subpoint
24+
- subpoint
25+
26+
<details>
27+
<summary>Show me</summary>
28+
<div>
29+
30+
Surprise!
31+
32+
</div>
33+
</details>
34+
35+
3. Another step
36+
37+
```yaml
38+
key: value
39+
```
40+
4. Image
41+
42+
![Test](../using-semaphore/img/account-gh-bb-access.jpg)
43+
44+
5. Finish
45+
46+
</Steps>

0 commit comments

Comments
 (0)