Skip to content

add CI pipeline and documentation #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+72 −0
Open

add CI pipeline and documentation #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Go CI Pipeline

on:
push:
pull_request:

jobs:
build-and-test:
runs-on: ubuntu-latest
defaults:
run:
working-directory: ./outyet

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: '1.21'

- name: Build
run: go build -o outyet-app

- name: Test
run: go test ./...

- name: Upload binary
uses: actions/upload-artifact@v4
with:
name: outyet-app
path: outyet/outyet-app
10 changes: 10 additions & 0 deletions .idea/.gitignore
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

29 changes: 29 additions & 0 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>The Multi-stage CI/CD Pipeline</title>
</head>
<body>
<h1>Multi-stage CI/CD Pipeline</h1>

<p>
The main purpose of a CI/CD pipeline is to automate the process of building, testing, and preparing code for deployment whenever new changes are introduced.
This helps identify errors early, ensures code quality, and makes development more efficient and reliable.
</p>

<p>In this project, the pipeline follows these stages:</p>

<ul>
<li><strong>Checkout:</strong> Retrieves the latest code from the repository to ensure the workflow uses the most up-to-date version.</li>
<li><strong>Setup:</strong> Configures the correct Go environment so that the application can be built and tested properly.</li>
<li><strong>Build:</strong> Uses <code>go build</code> inside the <code>outyet/</code> directory to compile the code and verify that it can run without syntax errors.</li>
<li><strong>Test:</strong> Runs <code>go test</code> to check that all functions behave as expected and that the logic remains correct after any changes.</li>
<li><strong>Upload:</strong> If the build is successful, the resulting binary is uploaded as an artifact for future use (e.g., deployment or review).</li>
</ul>

<p>
This type of automation reduces manual effort, minimizes the risk of human error, and speeds up the development workflow by giving quick feedback on every change.
</p>
</body>
</html>