Skip to content

Commit

Permalink
fix: adding the file .github wich was deleated ny mistake
Browse files Browse the repository at this point in the history
  • Loading branch information
Vlor999 committed Jan 2, 2025
1 parent e153dcd commit 3b7e122
Show file tree
Hide file tree
Showing 19 changed files with 656 additions and 227 deletions.
7 changes: 7 additions & 0 deletions .github/.codecov.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
coverage:
status:
project:
default:
# minimum of 97% (real 96%)
target: 97%
threshold: 1%
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @woile @Lee-W @noirbizarre
4 changes: 4 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# These are supported funding model platforms

open_collective: commitizen-tools
github: commitizen-tools
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: 🛠 Bug report
description: Create a report to help us improve
title: Good bug title tells us about precise symptom, not about the root cause.
labels: [bug]
body:
- type: textarea
id: description
attributes:
label: Description
description: |
A clear and concise description of what the bug is
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce
description: Steps to reproduce the behavior
placeholder: |
1. Run ...
2. ...
3. ...
validations:
required: true
- type: textarea
id: current-behavior
attributes:
label: Current behavior
description: What happens actually so you think this is a bug.
validations:
required: true
- type: textarea
id: desired-behavior
attributes:
label: Desired behavior
description: |
A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: |
If applicable, add screenshots to help explain your problem.
- type: textarea
id: environment
attributes:
label: Environment
description: |
For older commitizen versions, please include the output of the following commands manually
placeholder: |
- commitizen version: `cz version`
- python version: `python --version`
- operating system: `python3 -c "import platform; print(platform.system())"`
```bash
cz version --report
```
validations:
required: true
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Configuration: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository

blank_issues_enabled: false
contact_links:
- name: Security Contact
about: Please report security vulnerabilities to [email protected]
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: 📖 Documentation
description: Suggest an improvement for the documentation of this project
title: Content to be added or fixed
labels: [documentation]
body:
- type: checkboxes
id: type
attributes:
label: Type
options:
- label: Content inaccurate
- label: Content missing
- label: Typo
- type: input
id: url
attributes:
label: URL
placeholder: |
URL to the code we did not clearly describe or the document page where the content is inaccurate
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: |
A clear and concise description of what content should be added or fixed
validations:
required: true
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: 🚀 Feature request
description: Suggest an idea for this project
title: "<One feature request per issue>"
labels: [feature]
body:
- type: textarea
id: description
attributes:
label: Description
description: |
A clear and concise description for us to know your idea.
validations:
required: true
- type: textarea
id: possible-solution
attributes:
label: Possible Solution
description: |
A clear and concise description of what you want to happen.
- type: textarea
id: additional-context
attributes:
label: Additional context
description: |
Add any other context or screenshots about the feature request here.
- type: textarea
id: related-issue
attributes:
label: Additional context
description: |
If applicable, add link to existing issue also help us know better.
24 changes: 24 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
version: 2
updates:
-
# Maintain dependencies for GitHub Actions
package-ecosystem: github-actions
directory: /
schedule:
interval: daily
labels:
- dependencies
commit-message:
prefix: "ci"
include: "scope"
-
# Maintain python dependencies
package-ecosystem: pip
directory: /
schedule:
interval: daily
labels:
- dependencies
commit-message:
prefix: "build"
include: "scope"
3 changes: 3 additions & 0 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
'pr-status: wait-for-review':
- changed-files:
- any-glob-to-any-file: '**'
29 changes: 29 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!--
Thanks for sending a pull request!
Please fill in the following content to let us know better about this change.
-->

## Description
<!-- Describe what the change is -->


## Checklist

- [ ] Add test cases to all the changes you introduce
- [ ] Run `./scripts/format` and `./scripts/test` locally to ensure this change passes linter check and test
- [ ] Test the changes on the local machine manually
- [ ] Update the documentation for the changes

## Expected behavior
<!-- A clear and concise description of what you expected to happen -->


## Steps to Test This Pull Request
<!-- Steps to reproduce the behavior:
1. ...
2. ...
3. ... -->


## Additional context
<!-- Add any other RELATED ISSUE, context or screenshots about the pull request here. -->
29 changes: 29 additions & 0 deletions .github/workflows/bumpversion.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Bump version

on:
push:
branches:
- master

jobs:
bump-version:
if: "!startsWith(github.event.head_commit.message, 'bump:')"
runs-on: ubuntu-latest
name: "Bump version and create changelog with commitizen"
steps:
- name: Check out
uses: actions/checkout@v4
with:
fetch-depth: 0
token: "${{ secrets.PERSONAL_ACCESS_TOKEN }}"
- name: Create bump and changelog
uses: commitizen-tools/commitizen-action@master
with:
github_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
changelog_increment_filename: body.md
- name: Release
uses: ncipollo/release-action@v1
with:
tag: v${{ env.REVISION }}
bodyFile: "body.md"
skipIfReleaseExists: true
76 changes: 76 additions & 0 deletions .github/workflows/docspublish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
name: Publish documentation

on:
push:
branches:
- master

jobs:
update-cli-screenshots:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.x"
- name: Install dependencies
run: |
python -m pip install -U pip poetry
poetry --version
poetry install
- name: Update CLI screenshots
run: |
poetry run python scripts/gen_cli_help_screenshots.py
- name: Commit and push updated CLI screenshots
run: |
git config --global user.name "github-actions[bot]"
git config --global user.email "github-actions[bot]@users.noreply.github.com"
git add docs/images/cli_help
if [[ -n "$(git status --porcelain)" ]]; then
git commit -m "docs(cli/screenshots): update CLI screenshots" -m "[skip ci]"
git push
else
echo "No changes to commit. Skipping."
fi
publish-documentation:
runs-on: ubuntu-latest
needs: update-cli-screenshots
steps:
- uses: actions/checkout@v4
with:
token: "${{ secrets.PERSONAL_ACCESS_TOKEN }}"
fetch-depth: 0
- name: Pull latest changes
run: |
git pull origin master
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.x"
- name: Install dependencies
run: |
python -m pip install -U mkdocs mkdocs-material
- name: Build docs
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
python -m mkdocs build
- name: Generate Sponsors 💖
uses: JamesIves/github-sponsors-readme-action@v1
with:
token: ${{ secrets.PERSONAL_ACCESS_TOKEN_FOR_ORG }}
file: "docs/README.md"
- name: Push doc to Github Page
uses: peaceiris/actions-gh-pages@v4
with:
personal_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
publish_branch: gh-pages
publish_dir: ./site
user_name: "github-actions[bot]"
user_email: "github-actions[bot]@users.noreply.github.com"
32 changes: 32 additions & 0 deletions .github/workflows/homebrewpublish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Publish to Homebrew

on:
workflow_run:
workflows: ["Upload Python Package"]
types:
- completed

jobs:
deploy:
runs-on: macos-latest
if: ${{ github.event.workflow_run.conclusion == 'success' }}
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.x"
- name: Install dependencies
run: |
python -m pip install -U commitizen
- name: Set Project version env variable
run: |
echo "project_version=$(cz version --project)" >> $GITHUB_ENV
- name: Update Homebrew formula
uses: dawidd6/action-homebrew-bump-formula@v4
with:
token: ${{secrets.PERSONAL_ACCESS_TOKEN}}
formula: commitizen
tag: v${{ env.project_version }}
force: true
23 changes: 23 additions & 0 deletions .github/workflows/label_issues.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Label issues

on:
issues:
types:
- opened
- reopened

jobs:
label-issue:
permissions:
issues: write
runs-on: ubuntu-latest
steps:
- uses: actions/github-script@v7
with:
script: |
github.rest.issues.addLabels({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
labels: ['issue-status: needs-triage']
})
19 changes: 19 additions & 0 deletions .github/workflows/label_pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: "Label Pull Request"
on:
- pull_request_target

jobs:
label-pr:
permissions:
contents: read
pull-requests: write
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
sparse-checkout: |
.github/labeler.yml
sparse-checkout-cone-mode: false
- uses: actions/labeler@v5
with:
configuration-path: .github/labeler.yml
Loading

0 comments on commit 3b7e122

Please sign in to comment.