Skip to content

Commit 6555214

Browse files
santosr2santosr2
authored
docs!: modernize documentation with dual Node.js compatibility and community infrastructure (#33)
* docs!: modernize documentation with dual Node.js compatibility and community infrastructure BREAKING CHANGE: Update documentation structure and Node.js compatibility matrix This comprehensive documentation modernization introduces: **📚 Documentation Overhaul:** - README: Complete redesign with badges, compatibility matrix, and comprehensive sections - CONTRIBUTING: Enhanced with Node.js 22/24 matrix details and development workflow - SECURITY: Professional security policy with vulnerability reporting procedures - CONTRIBUTORS: Hall of Fame with recognition system and community engagement **🔗 Dual Node.js Compatibility:** - Node.js 22: Development and CI environment (Dependabot compatible) - Node.js 24: GitHub Actions runtime (using: node24) - CI matrix validation across both versions for all workflows - Explicit compatibility documentation throughout **🎯 Community Infrastructure:** - GitHub Discussions with 4 organized categories (Q&A, Ideas, Announcements, Show & Tell) - Project Board automation workflow documentation - Comprehensive badge system (CI, Security, Coverage, Performance, SBOM, Discussions) - Issue/PR templates for community engagement **🛠️ Technical Improvements:** - TypeScript strict configuration with maximum compiler options - Enhanced pre-commit hooks with comprehensive quality gates - Performance benchmarks with PredicateQuantifier enum fixes - SBOM generation and supply chain transparency - Complete TSDoc documentation for all public APIs **📊 Key Features:** - 84.08% test coverage with Node.js 22/24 matrix validation - 668KB optimized bundle with comprehensive security scanning - Real-time performance monitoring and bundle analysis - Supply chain transparency with CycloneDX v1.4 SBOM format The repository now provides production-ready documentation that clearly communicates the dual Node.js compatibility, security measures, and vibrant community infrastructure for contributors and users. Signed-off-by: Rubens <[email protected]> * chore: clean up and add discussion templates Signed-off-by: Rubens <[email protected]> * fix: codeql and ci workflows Signed-off-by: Rubens <[email protected]> * chore: use skywalking-eyes for license header check Signed-off-by: Rubens <[email protected]> * fix: pr title validation Signed-off-by: Rubens <[email protected]> * fix: labeler action Signed-off-by: Rubens <[email protected]> * fix: action/labeler , pr-validation and performance workflows Signed-off-by: Rubens <[email protected]> * fix: sbom workflows Signed-off-by: Rubens <[email protected]> * fix: sbom workflow, wrong parameter Signed-off-by: Rubens <[email protected]> * fix: sbom wrong value Signed-off-by: Rubens <[email protected]> --------- Signed-off-by: Rubens <[email protected]>
1 parent f969984 commit 6555214

Some content is hidden

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

63 files changed

+6429
-1874
lines changed

‎.github/DISCUSSION_TEMPLATE/announcements.yml‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
labels: ['announcement']
2+
body:
3+
- type: markdown
4+
attributes:
5+
value: |
6+
## 📢 Project Announcements
7+
8+
Share important updates, releases, breaking changes, or project news.
9+
10+
**For maintainers:** Use this template to keep the community informed about:
11+
- New releases and features
12+
- Breaking changes and migration guides
13+
- Project roadmap updates
14+
- Community milestones
15+
- Security updates
16+
17+
- type: dropdown
18+
id: type
19+
attributes:
20+
label: '📋 Announcement Type'
21+
description: 'What type of announcement is this?'
22+
options:
23+
- '🚀 New Release'
24+
- '⚠️ Breaking Change'
25+
- '🛡️ Security Update'
26+
- '📍 Roadmap Update'
27+
- '🎉 Milestone/Achievement'
28+
- '📚 Documentation Update'
29+
- '🔧 Infrastructure Change'
30+
- '💬 Community Update'
31+
- 'Other'
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: summary
37+
attributes:
38+
label: '📝 Summary'
39+
description: 'Brief overview of the announcement'
40+
placeholder: 'conditional-paths-action v2.0.0 is now available with...'
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: details
46+
attributes:
47+
label: '📋 Details'
48+
description: 'Detailed information about this announcement'
49+
placeholder: |
50+
## What's New
51+
- New feature X allows you to...
52+
- Performance improvements of up to 50%
53+
54+
## Breaking Changes
55+
- Configuration format has changed...
56+
57+
## Migration Guide
58+
To upgrade from v1.x...
59+
render: markdown
60+
61+
- type: textarea
62+
id: impact
63+
attributes:
64+
label: '🎯 User Impact'
65+
description: 'How does this affect users? What actions should they take?'
66+
placeholder: 'Users should upgrade to v2.0.0 by updating their workflows...'
67+
68+
- type: input
69+
id: version
70+
attributes:
71+
label: '🏷️ Version/Tag'
72+
description: 'Related version, tag, or milestone (if applicable)'
73+
placeholder: 'v2.0.0'
74+
75+
- type: textarea
76+
id: resources
77+
attributes:
78+
label: '🔗 Resources & Links'
79+
description: 'Relevant links, documentation, or resources'
80+
placeholder: |
81+
- [Release Notes](https://github.com/santosr2/conditional-paths-action/releases/tag/v2.0.0)
82+
- [Migration Guide](https://github.com/santosr2/conditional-paths-action/blob/main/MIGRATION.md)
83+
- [Updated Documentation](https://santosr2.github.io/conditional-paths-action/docs/)
84+
85+
- type: checkboxes
86+
id: urgency
87+
attributes:
88+
label: '⚡ Urgency'
89+
description: 'How urgent is this announcement?'
90+
options:
91+
- label: '🚨 Critical - Immediate action required'
92+
- label: '⚠️ Important - Action recommended soon'
93+
- label: '📝 Informational - Good to know'
94+
- label: '🎉 Celebratory - No action required'

‎.github/DISCUSSION_TEMPLATE/ideas.yml‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
labels: ['enhancement', 'idea']
2+
body:
3+
- type: markdown
4+
attributes:
5+
value: |
6+
## 💡 Feature Ideas & Enhancement Requests
7+
8+
Propose new features, improvements, or enhancements for conditional-paths-action.
9+
10+
**Before submitting:**
11+
- Check if a similar idea already exists
12+
- Consider if this fits the project's scope
13+
- Think about backward compatibility
14+
15+
- type: textarea
16+
id: summary
17+
attributes:
18+
label: '🎯 Feature Summary'
19+
description: 'Brief description of your idea'
20+
placeholder: 'Add support for excluding patterns from filters...'
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: problem
26+
attributes:
27+
label: '❗ Problem Statement'
28+
description: 'What problem does this solve? What use case does it address?'
29+
placeholder: "Currently, users can't easily exclude specific files from broad patterns..."
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: solution
35+
attributes:
36+
label: '💡 Proposed Solution'
37+
description: 'How would you like this feature to work? Include examples if possible.'
38+
placeholder: |
39+
```yaml
40+
filters: |
41+
frontend:
42+
- 'apps/frontend/**'
43+
- '!apps/frontend/**/*.test.ts'
44+
```
45+
render: yaml
46+
47+
- type: textarea
48+
id: alternatives
49+
attributes:
50+
label: '🔄 Alternative Solutions'
51+
description: 'Are there other ways to solve this problem? What have you considered?'
52+
placeholder: 'I considered using multiple filters, but that becomes complex...'
53+
54+
- type: dropdown
55+
id: impact
56+
attributes:
57+
label: '📊 Expected Impact'
58+
description: 'How many users do you think would benefit from this?'
59+
options:
60+
- 'High - Most users would benefit'
61+
- 'Medium - Many users in specific scenarios'
62+
- 'Low - Niche use case but valuable'
63+
- 'Unsure'
64+
validations:
65+
required: false
66+
67+
- type: dropdown
68+
id: complexity
69+
attributes:
70+
label: '🔧 Implementation Complexity'
71+
description: 'How complex do you think this feature would be to implement?'
72+
options:
73+
- 'Low - Simple configuration change'
74+
- 'Medium - New logic but straightforward'
75+
- 'High - Significant changes required'
76+
- 'Unsure'
77+
validations:
78+
required: false
79+
80+
- type: checkboxes
81+
id: contribution
82+
attributes:
83+
label: '🤝 Contribution'
84+
description: 'Are you interested in helping implement this?'
85+
options:
86+
- label: "I'd be willing to contribute code"
87+
- label: "I'd be willing to help with testing"
88+
- label: "I'd be willing to help with documentation"
89+
- label: 'I can provide detailed requirements'
90+
91+
- type: checkboxes
92+
id: breaking
93+
attributes:
94+
label: '⚠️ Breaking Changes'
95+
description: 'Could this feature introduce breaking changes?'
96+
options:
97+
- label: 'This would be backward compatible'
98+
- label: 'This might introduce breaking changes'
99+
- label: 'Unsure about backward compatibility'

‎.github/DISCUSSION_TEMPLATE/q-a.yml‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
labels: ['question']
2+
body:
3+
- type: markdown
4+
attributes:
5+
value: |
6+
## 💡 Q&A Discussion
7+
8+
Ask questions about using conditional-paths-action, get help with configuration, or discuss best practices.
9+
10+
**Before asking:**
11+
- Check the [documentation](https://santosr2.github.io/conditional-paths-action/docs/)
12+
- Search [existing discussions](https://github.com/santosr2/conditional-paths-action/discussions)
13+
- Review [examples](https://github.com/santosr2/conditional-paths-action/tree/main/examples)
14+
15+
- type: textarea
16+
id: question
17+
attributes:
18+
label: '❓ Your Question'
19+
description: 'Describe your question or issue in detail'
20+
placeholder: "I'm trying to configure filters for my monorepo..."
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: context
26+
attributes:
27+
label: '🔧 Configuration & Context'
28+
description: 'Share your current configuration, workflow setup, or relevant code'
29+
placeholder: |
30+
```yaml
31+
- uses: santosr2/conditional-paths-action@v1
32+
with:
33+
filters: |
34+
frontend: 'apps/frontend/**'
35+
```
36+
render: yaml
37+
38+
- type: textarea
39+
id: expected
40+
attributes:
41+
label: '✅ Expected Behavior'
42+
description: 'What did you expect to happen?'
43+
placeholder: 'I expected the frontend filter to trigger when...'
44+
45+
- type: textarea
46+
id: actual
47+
attributes:
48+
label: '❌ Actual Behavior'
49+
description: 'What actually happened?'
50+
placeholder: 'Instead, the action...'
51+
52+
- type: dropdown
53+
id: environment
54+
attributes:
55+
label: '🌍 Environment'
56+
description: 'What GitHub Actions runner are you using?'
57+
options:
58+
- ubuntu-latest
59+
- ubuntu-22.04
60+
- ubuntu-20.04
61+
- windows-latest
62+
- macos-latest
63+
- self-hosted
64+
- Other (please specify in context)
65+
validations:
66+
required: false
67+
68+
- type: checkboxes
69+
id: checklist
70+
attributes:
71+
label: '📋 Checklist'
72+
description: "Please confirm you've done the following:"
73+
options:
74+
- label: "I've read the documentation"
75+
- label: "I've searched existing discussions"
76+
- label: "I've provided a minimal example"
77+
- label: "I've included my configuration"

0 commit comments

Comments
 (0)