Skip to content

Commit bf3c7c2

Browse files
lachlangroselachlangrose
committed
initial commit
0 parents  commit bf3c7c2

63 files changed

Lines changed: 3847 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/ISSUE_TEMPLATE/10_bug_report.yml‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: Bug/Crash report.
2+
description: Create a bug report to help us improve our plugin.
3+
labels:
4+
- "Bug"
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this bug report correctly.
11+
12+
- type: textarea
13+
id: what
14+
attributes:
15+
label: What is the bug or the crash?
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
id: steps
21+
attributes:
22+
label: Steps to reproduce the issue
23+
description: |
24+
Steps, sample datasets and qgis project file to reproduce the behavior.
25+
Screencasts or screenshots are more than welcome, you can drag&drop them in the text box.
26+
27+
1. Go to '...'
28+
2. Click on '...'
29+
3. Scroll down to '...'
30+
4. See error
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: about-info
36+
attributes:
37+
label: Versions
38+
description: |
39+
In the QGIS Help menu -> About, click in the table, Ctrl+A and then Ctrl+C. Finally paste here.
40+
Do not make a screenshot.
41+
validations:
42+
required: true
43+
44+
- type: checkboxes
45+
id: qgis-version
46+
attributes:
47+
label: Supported QGIS version
48+
description: |
49+
Each month, there is a new release of QGIS. According to the release schedule, you should at least be running a supported QGIS version.
50+
You can check the release schedule https://www.qgis.org/en/site/getinvolved/development/roadmap.html#release-schedule
51+
options:
52+
- label: I'm running a supported QGIS version according to the official roadmap.
53+
54+
- type: checkboxes
55+
id: new-profile
56+
attributes:
57+
label: New profile
58+
description: |
59+
Did you try with a new QGIS profile? Some issues or crashes might be related to other plugins or specific configuration.
60+
You must try with a new profile to check if the issue remains.
61+
Read this link how to create a new profile
62+
https://docs.qgis.org/3.4/en/docs/user_manual/introduction/qgis_configuration.html#working-with-user-profiles
63+
options:
64+
- label: I tried with a new QGIS profile
65+
66+
- type: textarea
67+
id: additional-context
68+
attributes:
69+
label: Additional context
70+
description: |
71+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/15_feature_request.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Feature request
2+
description: Suggest a feature idea.
3+
labels:
4+
- 'Feature Request'
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this feature request correctly.
10+
11+
- type: textarea
12+
id: what
13+
attributes:
14+
label: Feature description
15+
description: A clear and concise description of what you want to happen.
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
id: Additional
21+
attributes:
22+
label: Additional context
23+
description: |
24+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
blank_issues_enabled: true
2+
3+
contact_links:
4+
- name: Documentation
5+
url: https://github.com/Loop3d/plugin_map2loop
6+
about: Please read carefully the documentation before to submit an issue.

‎.github/dependabot.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: pip
4+
directory: "/requirements"
5+
schedule:
6+
interval: monthly
7+
time: "04:00"
8+
9+
- package-ecosystem: "github-actions"
10+
directory: "/"
11+
schedule:
12+
interval: "monthly"

‎.github/labeler.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
ci-cd:
2+
- changed-files:
3+
- any-glob-to-any-file: .github/**
4+
5+
dependencies:
6+
- changed-files:
7+
- any-glob-to-any-file:
8+
- requirements/*.txt
9+
- requirements.txt
10+
11+
documentation:
12+
- changed-files:
13+
- any-glob-to-any-file:
14+
- docs/**
15+
- requirements/documentation.txt
16+
17+
enhancement:
18+
- head-branch:
19+
- ^feature
20+
- feature
21+
- ^improve
22+
- improve
23+
24+
packaging:
25+
- head-branch:
26+
- ^packaging
27+
- packaging
28+
- changed-files:
29+
- any-glob-to-any-file:
30+
- requirements/packaging.txt
31+
- setup.py
32+
33+
quality:
34+
- changed-files:
35+
- any-glob-to-any-file:
36+
- tests/**/*
37+
38+
39+
tooling:
40+
- head-branch:
41+
- ^tooling
42+
- tooling
43+
- changed-files:
44+
- any-glob-to-any-file:
45+
- .pre-commit-config.yaml
46+
- setup.cfg
47+
48+
UI:
49+
- head-branch:
50+
- ^ui
51+
- ui
52+
- changed-files:
53+
- any-glob-to-any-file:
54+
- plugin_map2loop/**/*.ui
55+
- plugin_map2loop/gui/**

‎.github/release.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
changelog:
2+
exclude:
3+
authors:
4+
- dependabot
5+
- pre-commit-ci
6+
categories:
7+
- title: Bugs fixes 🐛
8+
labels:
9+
- bug
10+
- title: Features and enhancements 🎉
11+
labels:
12+
- enhancement
13+
- UI
14+
- title: Tooling 🔧
15+
labels:
16+
- ci-cd
17+
- title: Documentation 📖
18+
labels:
19+
- documentation
20+
- title: Other Changes
21+
labels:
22+
- "*"

‎.github/workflows/auto-labeler.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: "🏷 PR Labeler"
2+
on:
3+
- pull_request_target
4+
5+
jobs:
6+
triage:
7+
permissions:
8+
contents: read
9+
pull-requests: write
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/labeler@v5
13+
with:
14+
repo-token: "${{ secrets.GITHUB_TOKEN }}"

‎.github/workflows/documentation.yml‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
name: "📚 Documentation"
2+
3+
# Global environment variables
4+
env:
5+
CONDITION_IS_PUSH: ${{ github.event_name == 'push' && (startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main') }}
6+
CONDITION_IS_WORKFLOW_RUN: ${{ github.event_name == 'workflow_run' && github.event.workflow_run.conclusion == 'success' }}
7+
PROJECT_FOLDER: plugin_map2loop
8+
PYTHON_VERSION: 3.12
9+
10+
# This workflow is triggered on:
11+
on:
12+
push:
13+
branches:
14+
- main
15+
paths:
16+
- '.github/workflows/documentation.yml'
17+
- 'docs/**/*'
18+
- "plugin_map2loop/**/*.py"
19+
- "plugin_map2loop/metadata.txt"
20+
- 'requirements/documentation.txt'
21+
tags:
22+
- "*"
23+
24+
pull_request:
25+
branches:
26+
- main
27+
paths:
28+
- ".github/workflows/documentation.yml"
29+
- docs/**/*
30+
- requirements/documentation.txt
31+
32+
workflow_dispatch:
33+
34+
workflow_run:
35+
workflows:
36+
- "📦 Package & 🚀 Release"
37+
types:
38+
- completed
39+
40+
41+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
42+
permissions:
43+
contents: read
44+
id-token: write
45+
pages: write
46+
47+
# Allow one concurrent deployment per branch/pr
48+
concurrency:
49+
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
50+
cancel-in-progress: true
51+
52+
jobs:
53+
build:
54+
runs-on: ubuntu-latest
55+
56+
steps:
57+
- name: Get source code
58+
uses: actions/checkout@v4
59+
60+
- name: Set up Python
61+
uses: actions/setup-python@v5
62+
with:
63+
cache: "pip"
64+
cache-dependency-path: "requirements/documentation.txt"
65+
python-version: ${{ env.PYTHON_VERSION }}
66+
67+
- name: Cache Sphinx cache
68+
uses: actions/cache@v4
69+
with:
70+
path: docs/_build/cache
71+
key: ${{ runner.os }}-sphinx-${{ hashFiles('docs/**/*') }}
72+
restore-keys: |
73+
${{ runner.os }}-sphinx-
74+
75+
- name: Install dependencies
76+
run: |
77+
python -m pip install -U pip setuptools wheel
78+
python -m pip install -U -r requirements/documentation.txt
79+
80+
- name: Build doc using Sphinx
81+
run: sphinx-build -b html -j auto -d docs/_build/cache -q docs docs/_build/html
82+
83+
- name: Download artifact from build workflow
84+
if: ${{ env.CONDITION_IS_PUSH || env.CONDITION_IS_WORKFLOW_RUN }}
85+
uses: dawidd6/action-download-artifact@v9
86+
with:
87+
allow_forks: false
88+
branch: main
89+
event: push
90+
github_token: ${{ secrets.GITHUB_TOKEN }}
91+
if_no_artifact_found: warn
92+
name: ${{ env.PROJECT_FOLDER }}-latest
93+
path: docs/_build/html/
94+
# run_id: ${{ github.event.workflow_run.id }}
95+
workflow: package_and_release.yml
96+
97+
- name: Save build doc as artifact
98+
uses: actions/upload-artifact@v4
99+
with:
100+
if-no-files-found: error
101+
name: documentation
102+
path: docs/_build/html/*
103+
retention-days: 30
104+
105+
- name: Setup Pages
106+
uses: actions/configure-pages@v5
107+
if: ${{ env.CONDITION_IS_PUSH || env.CONDITION_IS_WORKFLOW_RUN }}
108+
109+
- name: Upload artifact
110+
uses: actions/upload-pages-artifact@v3
111+
if: ${{ env.CONDITION_IS_PUSH || env.CONDITION_IS_WORKFLOW_RUN }}
112+
with:
113+
# Upload entire repository
114+
path: docs/_build/html/
115+
116+
- name: Deploy to GitHub Pages
117+
id: deployment
118+
if: ${{ env.CONDITION_IS_PUSH || env.CONDITION_IS_WORKFLOW_RUN }}
119+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)