1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
|
# Art Release Instructions
**Last Update: 2024-09-14**
1. Create the `release` branch under `dev`
2. Update all version tags
1. `setup.py`
2. `INSTALL.md`
3. `SECURITY.md`
4. `otherfile/version_check.py`
5. `otherfile/meta.yaml`
6. `art/params.py`
7. `ArtList.ipynb`
8. `DecorList.ipynb`
9. `FontList.ipynb`
3. Update `help_func` function output in `tests/test.py`
4. Update all font counters in `README.md` (**If needed**)
1. `<img src="https://img.shields.io/badge/Font List-{font_counter}-blue.svg" alt="Font List">`
2. `<td id="font_counter">{font_counter}</td>`
5. Update all art counters in `README.md` (**If needed**)
1. `<img src="https://img.shields.io/badge/Art List-{art_counter}-orange.svg" alt="Art List">`
2. `<td id="art_counter">{art_counter}</td>`
6. Update all decor counters in `README.md` (**If needed**)
1. `<img src="https://img.shields.io/badge/Decor List-{decor_counter}-green.svg" alt="Decor List">`
2. `<td id="decor_counter">{decor_counter}</td>`
7. Update `CHANGELOG.md`
1. Add a new header under `Unreleased` section (Example: `## [0.2] - 2022-08-17`)
2. Add a new compare link to the end of the file (Example: `[0.2]: https://github.com/sepandhaghighi/art/compare/v0.1...v0.2`)
3. Update `dev` compare link (Example: `[Unreleased]: https://github.com/sepandhaghighi/art/compare/v0.2...dev`)
8. Update `.github/ISSUE_TEMPLATE/bug_report.yml`
1. Add new version tag to `Art version` dropbox options
9. Update Document
1. Run `otherfile/doc_run.bat`
10. Create a PR from `release` to `dev`
1. Title: `Version x.x` (Example: `Version 0.1`)
2. Tag all related issues
3. Labels: `release`
4. Set milestone
5. Set project
6. Wait for all CI pass
7. Need review (**1** reviewer)
11. Merge `dev` branch into `master`
1. `git checkout master`
2. `git merge dev`
3. `git push origin master`
4. Wait for all CI pass
12. Create a new release
1. Target branch: `master`
2. Tag: `vx.x` (Example: `v0.1`)
3. Title: `Version x.x` (Example: `Version 0.1`)
4. Copy changelogs
5. Tag all related issues
13. Bump!!
14. Close this version issues
15. Close milestone
16. Close project
17. Generate HTML files
1. Run `otherfile/doc_to_html.bat`
2. Copy `doc_html` folder for the next steps
18. Update website
1. `git checkout gh-pages`
2. Update all version tags
1. `index.html`
3. Update fonts list
1. Update `FontList.html` (Step **17.2**)
4. Update arts list
1. Update `ArtList.html` (Step **17.2**)
5. Update decors list
1. Update `DecorList.html` (Step **17.2**)
6. Update all font counters in `index.html` (**If needed**)
1. `<img src="https://img.shields.io/badge/Font List-{font_counter}-blue.svg" alt="Font List">`
2. `<td id="font_counter">{font_counter}</td>`
7. Update all art counters in `index.html` (**If needed**)
1. `<img src="https://img.shields.io/badge/Art List-{art_counter}-orange.svg" alt="Art List">`
2. `<td id="art_counter">{art_counter}</td>`
8. Update all decor counters in `index.html` (**If needed**)
1. `<img src="https://img.shields.io/badge/Decor List-{decor_counter}-green.svg" alt="Decor List">`
2. `<td id="decor_counter">{decor_counter}</td>`
9. Update `References` section (**If needed**)
10. Update code examples (**If needed**)
1. [http://www.hilite.me](http://www.hilite.me)
2. Python console session
3. Colorful
4. Line numbers
|