Skip to content

Commit 9109492

Browse files
swimmwatchswimmwatch
authored
Merge pull request #724 from swimmwatch/dev
Release v1.1.0
2 parents 16b395b + 434f1ed commit 9109492

44 files changed

Lines changed: 2329 additions & 543 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/bug_report.md‎

Lines changed: 25 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,45 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
3+
about: Report a reproducible problem
44
title: ''
55
labels: bug
66
assignees: swimmwatch
7-
87
---
98

10-
---
11-
name: Bug report
12-
about: Create a report to help us improve
13-
title: ''
14-
labels: bug
15-
assignees: swimmwatch
9+
<!-- Do not report security vulnerabilities publicly. See SECURITY.md instead. -->
1610

17-
---
11+
## Summary
1812

19-
<!--- Provide a general summary of the issue in the Title above -->
13+
<!-- Provide a concise description of the problem. -->
2014

21-
## Expected Behavior
22-
<!--- Tell us what should happen -->
15+
## Environment
2316

24-
## Current Behavior
25-
<!--- Tell us what happens instead of the expected behavior -->
17+
- `vk-mini-app-auth` version:
18+
- Python version:
19+
- Operating system:
2620

27-
## Possible Solution
28-
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
21+
## Steps To Reproduce
2922

30-
## Steps to Reproduce
31-
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
32-
<!--- reproduce this bug. Include code to reproduce, if relevant -->
3323
1.
3424
2.
3525
3.
36-
4.
3726

38-
## Context (Environment)
39-
<!--- How has this issue affected you? What are you trying to accomplish? -->
40-
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
27+
## Expected Behavior
28+
29+
<!-- Tell us what should happen. -->
30+
31+
## Actual Behavior
32+
33+
<!-- Tell us what happens instead. Include traceback or logs when available. -->
34+
35+
## Minimal Example
36+
37+
<!-- Add the smallest code or input sample that reproduces the issue. -->
38+
39+
```python
4140

42-
<!--- Provide a general summary of the issue in the Title above -->
41+
```
4342

44-
## Detailed Description
45-
<!--- Provide a detailed description of the change or addition you are proposing -->
43+
## Additional Context
4644

47-
## Possible Implementation
48-
<!--- Not obligatory, but suggest an idea for implementing addition or change -->
45+
<!-- Add any other context that may help diagnose the issue. -->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,28 @@
11
---
2-
name: Feature request
3-
about: Suggest an idea for this project
2+
name: Maintenance proposal
3+
about: Suggest a scoped compatibility, documentation, CI, or packaging improvement
44
title: ''
55
labels: enhancement
66
assignees: swimmwatch
7-
87
---
98

10-
---
11-
name: Feature request
12-
about: Suggest an idea for this project
13-
title: ''
14-
labels: enhancement
15-
assignees: swimmwatch
9+
<!--
10+
This project is in maintenance mode. Broad new features and new runtime framework
11+
integrations are unlikely to be accepted without prior discussion.
12+
-->
1613

17-
---
14+
## Problem
15+
16+
<!-- What problem or compatibility gap should be addressed? -->
17+
18+
## Proposed Change
19+
20+
<!-- Describe the smallest useful change. -->
1821

19-
**Is your feature request related to a problem? Please describe.**
20-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
22+
## Alternatives Considered
2123

22-
**Describe the solution you'd like**
23-
A clear and concise description of what you want to happen.
24+
<!-- Mention other approaches if relevant. -->
2425

25-
**Describe alternatives you've considered**
26-
A clear and concise description of any alternative solutions or features you've considered.
26+
## Impact
2727

28-
**Additional context**
29-
Add any other context or screenshots about the feature request here.
28+
<!-- Describe API, dependency, documentation, testing, or CI impact. -->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,39 @@
1-
THIS PROJECT IS IN MAINTENANCE MODE. We accept pull-requests for Bug Fixes **ONLY**. NO NEW FEATURES ACCEPTED!
1+
<!--
2+
Keep pull requests focused. This project is in maintenance mode, so bug fixes,
3+
security fixes, dependency updates, documentation fixes, CI fixes, and small
4+
compatibility improvements are expected. Discuss broad feature work in an issue first.
5+
-->
26

3-
<!--- Provide a general summary of your changes in the Title above -->
7+
## Summary
48

5-
## Description
6-
<!--- Describe your changes in detail -->
9+
<!-- Briefly describe what changed and why. -->
710

811
## Related Issue
9-
<!--- This project only accepts pull requests related to open issues -->
10-
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
11-
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
12-
<!--- Please link to the issue here: -->
1312

14-
## Motivation and Context
15-
<!--- Why is this change required? What problem does it solve? -->
16-
<!--- If it fixes an open issue, please link to the issue here. -->
13+
<!-- Link the issue if one exists. Use "Closes #123" when appropriate. -->
1714

18-
## How Has This Been Tested (if appropriate)?
19-
<!--- Please describe in detail how you tested your changes. -->
20-
<!--- Include details of your testing environment, and the tests you ran to -->
21-
<!--- see how your change affects other areas of the code, etc. -->
15+
## Change Type
2216

23-
## Screenshots (if appropriate):
17+
- [ ] Bug fix
18+
- [ ] Security fix
19+
- [ ] Dependency maintenance
20+
- [ ] Documentation update
21+
- [ ] CI or packaging update
22+
- [ ] Compatibility improvement
23+
24+
## Verification
25+
26+
<!-- List the checks you ran, or explain why they are not applicable. -->
27+
28+
- [ ] `make lint`
29+
- [ ] `make test`
30+
- [ ] `poetry run mkdocs build --strict --site-dir /tmp/vk-mini-app-auth-site`
31+
- [ ] `make actionlint`
32+
33+
## Checklist
34+
35+
- [ ] I kept the change focused and scoped to this pull request.
36+
- [ ] I preserved public API compatibility or documented an accepted breaking change.
37+
- [ ] I updated tests for behavior changes.
38+
- [ ] I updated documentation for public behavior or usage changes.
39+
- [ ] I did not commit generated artifacts, secrets, or unrelated files.

‎.github/actions/webchanges-action/action.yml‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
name: "Web changes detector"
2+
author: "Dmitry Vasiliev"
3+
description: "Detect changes in web pages and notify via GitHub Actions"
4+
branding:
5+
icon: "check-circle"
6+
color: "blue"
7+
8+
inputs:
9+
config:
10+
description: "Configuration for the web changes detector"
11+
required: true
12+
jobs:
13+
description: "List of jobs to run for web changes detection"
14+
required: true
15+
16+
runs:
17+
using: "composite"
18+
steps:
19+
- name: "Set up environment"
20+
shell: bash
21+
run: |
22+
echo "WEBCHANGES_ACTION_DIR=${{ runner.temp }}/webchanges-action" >> "$GITHUB_ENV"
23+
echo "CONFIG_PATH=${{ runner.temp }}/webchanges-action/config.yaml" >> "$GITHUB_ENV"
24+
echo "JOBS_PATH=${{ runner.temp }}/webchanges-action/jobs.yaml" >> "$GITHUB_ENV"
25+
echo "SNAPSHOTS_DIR=${{ runner.temp }}/webchanges-action-cache" >> "$GITHUB_ENV"
26+
echo "SNAPSHOTS_DB=${{ runner.temp }}/webchanges-action-cache/snapshots.db" >> "$GITHUB_ENV"
27+
echo "HOOKS_PATH=${{ github.action_path }}/hooks.py" >> "$GITHUB_ENV"
28+
echo "WEBCHANGES_VERSION=3.36.1" >> "$GITHUB_ENV"
29+
echo "PYTHON_VERSION=3.10" >> "$GITHUB_ENV"
30+
- name: "Create work directories"
31+
shell: bash
32+
run: |
33+
mkdir -p "$WEBCHANGES_ACTION_DIR" "$SNAPSHOTS_DIR"
34+
- name: "Write configs to files"
35+
shell: bash
36+
run: |
37+
cat > "$CONFIG_PATH" <<'WEBCHANGES_CONFIG'
38+
${{ inputs.config }}
39+
WEBCHANGES_CONFIG
40+
cat > "$JOBS_PATH" <<'WEBCHANGES_JOBS'
41+
${{ inputs.jobs }}
42+
WEBCHANGES_JOBS
43+
- name: "Setup Python"
44+
uses: actions/setup-python@v6
45+
with:
46+
python-version: ${{ env.PYTHON_VERSION }}
47+
cache: "pip"
48+
- name: "Install webchanges package"
49+
shell: bash
50+
run: |
51+
pip install webchanges==${{ env.WEBCHANGES_VERSION }}
52+
- name: "Compute cache key"
53+
shell: bash
54+
run: |
55+
CONFIG_HASH=$(sha256sum "$CONFIG_PATH" "$JOBS_PATH" | sha256sum | awk '{ print $1 }')
56+
echo "CACHE_PREFIX=${{ runner.os }}-webchanges-${CONFIG_HASH}-" >> "$GITHUB_ENV"
57+
echo "CACHE_KEY=${{ runner.os }}-webchanges-${CONFIG_HASH}-${{ github.run_id }}-${{ github.run_attempt }}" >> "$GITHUB_ENV"
58+
- name: "Restore cache snapshots database"
59+
uses: actions/cache/restore@v4
60+
with:
61+
path: "${{ env.SNAPSHOTS_DIR }}"
62+
key: "${{ env.CACHE_KEY }}"
63+
restore-keys: |
64+
${{ env.CACHE_PREFIX }}
65+
- name: "Check if snapshots database exists"
66+
shell: bash
67+
run: |
68+
if [ ! -f "$SNAPSHOTS_DB" ]; then
69+
echo "No snapshots database found, creating a new one."
70+
else
71+
echo "Snapshots database found, using existing one."
72+
fi
73+
- name: "Secure hooks file permissions"
74+
shell: bash
75+
run: |
76+
chmod go-w "$HOOKS_PATH" "$(dirname "$HOOKS_PATH")"
77+
- name: "Run web changes detection"
78+
shell: bash
79+
run: |
80+
webchanges --config "$CONFIG_PATH" --jobs "$JOBS_PATH" --hooks "$HOOKS_PATH" --database "$SNAPSHOTS_DB"
81+
- name: "Cache snapshots database"
82+
uses: actions/cache/save@v4
83+
with:
84+
path: "${{ env.SNAPSHOTS_DIR }}"
85+
key: "${{ env.CACHE_KEY }}"

0 commit comments

Comments
 (0)