Skip to content

Commit

Permalink
Add initial GitHub Actions workflow for CI
Browse files Browse the repository at this point in the history
This commit introduces the initial setup for a GitHub Actions workflow, named 'blank.yml', to the Idea Stock Exchange project. It establishes the foundation for continuous integration (CI), ensuring automated testing and linting are performed on pushes and pull requests to the main branch. The workflow is configured with basic steps for setting up the environment (e.g., Node.js), installing dependencies, running linters, and executing tests. This addition marks a significant step towards maintaining code quality and streamlining the development process. Further customization and enhancements to the workflow will be made as the project evolves to include additional automation like deployment and documentation generation.


Signed-off-by: Myklob <[email protected]>
  • Loading branch information
myklob authored Nov 20, 2023
1 parent 5fc05d9 commit ee3a7ae
Showing 1 changed file with 64 additions and 0 deletions.
64 changes: 64 additions & 0 deletions .github/workflows/blank.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
To customize the GitHub Actions workflow for the Idea Stock Exchange project, we'll adapt the template to fit the specific needs of the project. This includes setting up automated actions for code integration, testing, and deployment. Here's a revised workflow:

```yaml
# This workflow is designed for the Idea Stock Exchange project to automate integration and testing
name: Idea Stock Exchange CI
# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the "main" branch
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
# Allows manual workflow runs from the Actions tab
workflow_dispatch:
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a job for building and testing
build_and_test:
# Using the latest Ubuntu runner
runs-on: ubuntu-latest
# Sequence of tasks executed as part of the job
steps:
# Checks-out the repository for access in the job
- uses: actions/checkout@v3
# Set up Node.js environment for JavaScript projects (if applicable)
- name: Set up Node.js
uses: actions/setup-node@v2
with:
node-version: '16'
# Install dependencies (if applicable, for projects using npm)
- name: Install dependencies
run: npm install
# Run linting to ensure code quality (if applicable)
- name: Run linter
run: npm run lint
# Run automated tests defined in the project
- name: Run tests
run: npm test
# (Optional) Add additional steps for deployment or other automated tasks
# - name: Deploy to production
# run: <deployment command>
# (Optional) Add additional jobs for deployment, documentation generation, etc.
```

This workflow:

- Triggers on pushes and pull requests to the `main` branch, and can be manually triggered.
- Sets up a job called `build_and_test` running on the latest Ubuntu.
- Checks out the repository for access within the job.
- Sets up Node.js, installs dependencies, runs linting, and executes tests. (These steps are examples and should be adapted based on the project's tech stack and requirements.)
- Includes comments for adding additional steps like deployment.

Adjust the script as needed to match the specific requirements of the Idea Stock Exchange project, including the programming language, testing frameworks, and deployment processes.

0 comments on commit ee3a7ae

Please sign in to comment.