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.

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

Bump version: 1.0.3 → 1.0.4 #17

Merged
merged 5 commits into from
Oct 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 1.0.3
current_version = 1.0.4
commit = True
tag = False

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release-controller.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ jobs:
zip -r "${REPO_NAME}-${GITHUB_REF_NAME}.zip" \
{INSTALL,SECURITY,README,ICONS,CONTRIBUTING,CODE_OF_CONDUCT}.md \
requirements.txt .github scripts frontend backend \
pyproject.toml
pyproject.toml LICENSE
# "${FOLDER_TO_COMPRESS}"
env:
REPO_NAME: ${{ env.REPO_NAME }}
Expand Down
19 changes: 14 additions & 5 deletions .github/workflows/version-controller.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,19 @@ jobs:
fi
echo "next_branch=$NEXT_BRANCH" >> $GITHUB_OUTPUT
echo "current_branch=$CURRENT_BRANCH" >> $GITHUB_OUTPUT
- name: Run Changelog Generator
id: run_changelog
- name: Add Modules
id: add_modules
env:
ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
run: |
python scripts/generate_changelog/main.py
git config --global url."https://${ACCESS_TOKEN}@github.com/".insteadOf "https://github.com/"
git rm -r --cached scripts || true
rm -rf scripts
git submodule add -b ${{ steps.determine_branch.outputs.current_branch }} https://github.com/JuanVilla424/scripts.git
# - name: Run Changelog Generator
# id: run_changelog
# run: |
# python scripts/generate_changelog/main.py
- name: Check for Forbidden Character
id: check_arrow
run: |
Expand Down Expand Up @@ -99,8 +108,8 @@ jobs:
script: |
const head = '${{ steps.determine_branch.outputs.current_branch }}';
const base = '${{ steps.determine_branch.outputs.next_branch }}';
const title = `from ${{ steps.determine_branch.outputs.current_branch }} - ${{ steps.get_commit.outputs.commit_message }} into ${{ steps.determine_branch.outputs.next_branch }}`;
const body = `Automatically created pull request for release ${{ steps.create_tag.outputs.tag_name }} into ${base} branch.`;
const title = `${{ steps.get_commit.outputs.commit_message }}`;
const body = `Automatically created pull request for release ${{ steps.create_tag.outputs.tag_name }} into ${base} branch. From ${{ steps.get_commit.outputs.commit_message }}`;

const { data: existingPRs } = await github.rest.pulls.list({
owner: context.repo.owner,
Expand Down
4 changes: 4 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[submodule "scripts"]
path = scripts
url = https://github.com/JuanVilla424/scripts.git
branch = dev
1 change: 1 addition & 0 deletions CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
template.bridgefusion.icu
30 changes: 27 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Welcome to the **GitHub CI/CD Template** repository! This project provides a rob
- [Installation](#-installation)
- [Environment Setup](#-environment-setup)
- [Pre-Commit Hooks](#-pre-commit-hooks)
- [Extra Steps](#-extra-steps)
- [Usage](#-usage)
- [Contributing](#-contributing)
- [License](#-license)
Expand All @@ -39,7 +40,7 @@ Welcome to the **GitHub CI/CD Template** repository! This project provides a rob
- **Python 3.12+:** Ensure Python is installed on your local machine.
- **Git:** Install [Git](https://git-scm.com/) to clone the repository.
- **NVM:** (Optional) Node.js installation environment versions control
- **Node.js 22.x+**: (Optional) (Required to Push) Used as lintr orchestation commander in pre-commit and pre-push
- **Node.js 22.x+**: (Optional) (Required to Push) Used as lint orchestration manager in pre-commit and pre-push

### 🔨 Installation

Expand Down Expand Up @@ -77,7 +78,13 @@ Setting up a Python virtual environment ensures that dependencies are managed ef
On Windows:

```bash
venv\Scripts\activate
.\venv\Scripts\activate
```

- or

```bash
powershell.exe -ExecutionPolicy Bypass -File .\venv\Scripts\Activate.ps1
```

3. **Upgrade pip**
Expand All @@ -103,6 +110,8 @@ Setting up a Python virtual environment ensures that dependencies are managed ef
deactivate
```

5. **Docker Extra Steps**: Install Scoop and then install hadolint using scoop, refer to [Extra Steps](#-extra-steps)

### 🛸 Pre-Commit Hooks

**Install and check pre-commit hooks**: MD files changes countermeasures, python format, python lint, yaml format, yaml lint, version control hook, changelog auto-generation
Expand All @@ -115,6 +124,21 @@ pre-commit autoupdate
pre-commit run --all-files
```

### 📌 Extra Steps

1. **Docker**:

- Using MacOs or Linux:
```bash
brew install hadolint
```
- On Windows **as non-admin user**:
```bash
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
Invoke-RestMethod -Uri https://get.scoop.sh | Invoke-Expression
scoop install halint
```

## 🛠️ Usage

**To utilize the CI/CD pipeline, follow these steps**:
Expand All @@ -130,7 +154,7 @@ pre-commit run --all-files
2. **Set Up Secrets**

- Go to your GitHub repository settings.
- Navigate to Secrets and add necessary secrets like AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, etc.
- Navigate to Secrets and add necessary secrets like CODECOV_KEY, etc.

3. **Triggering the Pipeline**

Expand Down
4 changes: 2 additions & 2 deletions backend/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "backend"
version = "1.0.3"
version = "1.0.4"
description = "Github CICD Template Repository."
authors = ["B <[email protected]>"]
license = "Other"
Expand Down Expand Up @@ -65,5 +65,5 @@ ensure_newline_before_comments = true
rcfile = ".pylintrc"

[build-system]
requires = ["poetry-core>=1.0.3"]
requires = ["poetry-core>=1.0.4"]
build-backend = "poetry.core.masonry.api"
2 changes: 1 addition & 1 deletion frontend/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "frontend",
"version": "1.0.3",
"version": "1.0.4",
"description": "frontend github cicd sample",
"private": "true",
"dependencies": {
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "github-cicd-template"
version = "1.0.3"
version = "1.0.4"
description = "Github CICD Template Repository"
authors = ["B <[email protected]>"]
license = "Apache 2.0"
Expand Down Expand Up @@ -66,5 +66,5 @@ ensure_newline_before_comments = true
rcfile = ".pylintrc"

[build-system]
requires = ["poetry-core>=1.0.3"]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"
1 change: 1 addition & 0 deletions scripts
Submodule scripts added at dfabdc
67 changes: 0 additions & 67 deletions scripts/bump_year/main.py

This file was deleted.

123 changes: 0 additions & 123 deletions scripts/commit_msg_version_bump/main.py

This file was deleted.

Loading
Loading