|
| 1 | +# GitHub Issues Creation Scripts |
| 2 | + |
| 3 | +This directory contains scripts to create GitHub issues for the ydb-embedded-ui feature requests. |
| 4 | + |
| 5 | +## Issue Templates |
| 6 | + |
| 7 | +All issue templates are defined in `/ISSUES_TO_CREATE.md`. This document contains detailed descriptions, requirements, benefits, and related areas for each of the 11 feature requests. |
| 8 | + |
| 9 | +## Available Scripts |
| 10 | + |
| 11 | +### 1. Bash Script (`create-issues.sh`) |
| 12 | + |
| 13 | +Uses the GitHub CLI (`gh`) to create issues. |
| 14 | + |
| 15 | +**Prerequisites:** |
| 16 | +- GitHub CLI installed: https://cli.github.com/ |
| 17 | +- Authenticated with GitHub: `gh auth login` |
| 18 | + |
| 19 | +**Usage:** |
| 20 | +```bash |
| 21 | +./scripts/create-issues.sh |
| 22 | +``` |
| 23 | + |
| 24 | +### 2. Python Script (`create-issues.py`) |
| 25 | + |
| 26 | +Uses the GitHub REST API to create issues. |
| 27 | + |
| 28 | +**Prerequisites:** |
| 29 | +- Python 3.6 or higher |
| 30 | +- `requests` library: `pip install requests` |
| 31 | +- GitHub personal access token with `repo` scope |
| 32 | + |
| 33 | +**Usage:** |
| 34 | +```bash |
| 35 | +# Set your GitHub token |
| 36 | +export GITHUB_TOKEN='your_personal_access_token_here' |
| 37 | + |
| 38 | +# Run the script |
| 39 | +python3 scripts/create-issues.py |
| 40 | +``` |
| 41 | + |
| 42 | +**Creating a Personal Access Token:** |
| 43 | +1. Go to https://github.com/settings/tokens |
| 44 | +2. Click "Generate new token (classic)" |
| 45 | +3. Give it a descriptive name |
| 46 | +4. Select the `repo` scope (or `public_repo` for public repositories only) |
| 47 | +5. Click "Generate token" |
| 48 | +6. Copy the token (you won't be able to see it again!) |
| 49 | + |
| 50 | +## Features to be Created |
| 51 | + |
| 52 | +The scripts will create the following 11 issues: |
| 53 | + |
| 54 | +1. **Save Query History** - Persist and display query history in SQL Editor |
| 55 | +2. **Download Query Results** - Export query results in various formats |
| 56 | +3. **Charts for Query Results** - Visualize query results with charts |
| 57 | +4. **Display Resource Pools** - View and monitor resource pools |
| 58 | +5. **Specify Resource Pools** - Select resource pools for query execution |
| 59 | +6. **Column Compression Coefficient** - Display compression stats for columnar tables |
| 60 | +7. **Tiering Settings and Statistics** - Show tiering configuration for columnar tables |
| 61 | +8. **Data Read Volume** - Display blob storage read volume for queries |
| 62 | +9. **Subcolumns Settings** - Show subcolumns configuration for columnar tables |
| 63 | +10. **Snapshot Isolation Level** - Specify isolation level for queries |
| 64 | +11. **Skip Indexes Structure** - Display skip indexes for columnar tables |
| 65 | + |
| 66 | +## Manual Creation |
| 67 | + |
| 68 | +If you prefer to create issues manually or the scripts don't work for your environment: |
| 69 | + |
| 70 | +1. Open the repository: https://github.com/ydb-platform/ydb-embedded-ui |
| 71 | +2. Click on "Issues" tab |
| 72 | +3. Click "New issue" |
| 73 | +4. Copy the title and description from `ISSUES_TO_CREATE.md` |
| 74 | +5. Add the "enhancement" label |
| 75 | +6. Submit the issue |
| 76 | +7. Repeat for all 11 issues |
| 77 | + |
| 78 | +## Notes |
| 79 | + |
| 80 | +- All issues are labeled as "enhancement" |
| 81 | +- The issue titles follow conventional commit format: `feat: <description>` |
| 82 | +- Each issue includes requirements, benefits, and related code areas |
| 83 | +- Some issues may depend on backend API support from YDB core |
| 84 | + |
| 85 | +## Troubleshooting |
| 86 | + |
| 87 | +### Bash Script Issues |
| 88 | + |
| 89 | +**Error: "gh: command not found"** |
| 90 | +- Install GitHub CLI from https://cli.github.com/ |
| 91 | + |
| 92 | +**Error: "GitHub CLI is not authenticated"** |
| 93 | +- Run: `gh auth login` and follow the prompts |
| 94 | + |
| 95 | +### Python Script Issues |
| 96 | + |
| 97 | +**Error: "requests library is not installed"** |
| 98 | +- Install it with: `pip install requests` or `pip3 install requests` |
| 99 | + |
| 100 | +**Error: "GITHUB_TOKEN environment variable is not set"** |
| 101 | +- Set your token: `export GITHUB_TOKEN='your_token'` |
| 102 | + |
| 103 | +**Error: "Bad credentials"** |
| 104 | +- Check that your token is valid and has the correct permissions |
| 105 | +- Tokens expire, you may need to generate a new one |
| 106 | + |
| 107 | +**Error: "Rate limit exceeded"** |
| 108 | +- GitHub API has rate limits |
| 109 | +- Authenticated requests have higher limits |
| 110 | +- Wait a few minutes and try again |
| 111 | + |
| 112 | +## Support |
| 113 | + |
| 114 | +For issues with the scripts or questions about the features, please: |
| 115 | +1. Check the detailed descriptions in `ISSUES_TO_CREATE.md` |
| 116 | +2. Review the repository's CONTRIBUTING.md |
| 117 | +3. Contact the YDB team at info@ydb.tech |
0 commit comments