Skip to content
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

Jump to bottom

Update GitHub Actions documentation #12

Merged
merged 4 commits into from
Feb 9, 2024
Merged

Update GitHub Actions documentation #12

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a17f245
test circleci
Yanglin-Tao Feb 8, 2024
096b3cf
testing again
Yanglin-Tao Feb 8, 2024
9d5aa15
Merge branch 'main' into test-yanglin
Yanglin-Tao Feb 9, 2024
640ec92
Update GitHub Actions documentation
Yanglin-Tao Feb 9, 2024
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
21 changes: 14 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ This is an advanced template for designing and developing Python projects with C

The details of this template are listed below:

The programming language: Python
- The programming language: Python

Testing Framework: Pytest
- Testing Framework: Pytest

Continuous Integration Solution: CircleCI
- Continuous Integration Solution: GitHub Actions, CircleCI

Static Analysis Tools: Ruff, Flake8, MyPy
- Static Analysis Tools: Ruff, Flake8, MyPy

Code Formatting Solution: Black
- Code Formatting Solution: Black

Package/Dependency Manager: PDM (Python Dependency Management)
- Package/Dependency Manager: PDM (Python Dependency Management)

## Initial Setup

Expand Down Expand Up @@ -48,9 +48,16 @@ To run the application, run the following:

pdm run src/main.py

## Continuous Integration with GitHub Actions
This project is configured to use GitHub Actions for continuous integration. Every push to the repository triggers automated tests and checks to ensure code quality and functionality.

To see the status of your build, navigate to the main page of the repository. Go to Actions, and in the left sidebar, click the workflow you want to display. From the list of workflow runs, click the name of the run you want to see. There, you can view the logs that shows you how each of the steps was processed.

If you need to customize the build process, modify the `.github/workflows/github-actions.yml` file according to your needs. For detailed instructions, refer to the [GitHub Actions Documentation](https://docs.github.com/en/actions).

## Continuous Integration with CircleCI

This project is configured to use CircleCI for continuous integration. Every push to the repository triggers automated tests and checks to ensure code quality and functionality.
As an alternative, this project is also configured to use CircleCI for continuous integration.

To see the status of your build, visit the CircleCI dashboard. There, you can view the progress and results of the build tests, static analysis, and more for your latest commits.

Expand Down
Loading