File tree Expand file tree Collapse file tree 2 files changed +10
-7
lines changed
Expand file tree Collapse file tree 2 files changed +10
-7
lines changed Original file line number Diff line number Diff line change 11# Package Name
22
33[ ![ Run tests] ( https://github.com/opencitations/python-package-template/actions/workflows/tests.yml/badge.svg )] ( https://github.com/opencitations/python-package-template/actions/workflows/tests.yml )
4- [ ![ PyPI version] ( https://badge.fury.io/py/package-name.svg )] ( https://badge.fury.io/py/package-name )
54[ ![ License: ISC] ( https://img.shields.io/badge/License-ISC-blue.svg )] ( https://opensource.org/licenses/ISC )
65
76Package description.
Original file line number Diff line number Diff line change @@ -305,19 +305,23 @@ def main() -> int:
305305
306306 print_header ("Setup complete" )
307307 print ("Your project is ready. Next steps:\n " )
308- print ("1. Commit and push:" )
309- print (" git add ." )
310- print (' git commit -m "feat: initial project setup"' )
311- print (" git push" )
312- print ()
313- print ("2. Configure GitHub repository:" )
308+ print ("1. Configure GitHub repository:" )
314309 print (" - Create PyPI token: https://pypi.org/manage/account/token/" )
315310 print (f" - Add as secret: https://github.com/{ github_username } /{ package_name } /settings/secrets/actions/new" )
316311 print (" Name: PYPI_TOKEN" )
317312 if include_docs :
318313 print (f" - Enable GitHub Pages: https://github.com/{ github_username } /{ package_name } /settings/pages" )
319314 print (" Source: GitHub Actions" )
320315 print ()
316+ print ("2. Commit and push:" )
317+ print (" git add ." )
318+ print (' git commit -m "feat: initial project setup"' )
319+ print (" git push" )
320+ if include_docs :
321+ print ()
322+ print (" Warning: if GitHub Pages is not configured with 'GitHub Actions'" )
323+ print (" as source, the documentation deployment will fail." )
324+ print ()
321325 print ("3. Start developing:" )
322326 print (f" - Edit src/{ package_underscore } /__init__.py" )
323327 print (" - Add tests in tests/" )
You can’t perform that action at this time.
0 commit comments