pypiserver/bin
Glenn 9edae77659
Feature/markdown conversion (#503)
* feat: markdown conversion

logo and badges

* feat: markdown conversion

fix logo path

* feat: markdown

table changes

* feat: markdown

table alignment

* feat: markdown

check toc

* feat: markdown

toc additions

* feat: markdown

quickstart section

* feat: dependabot

more details section in quick start

* feat: dependabot

correct bold

* feat: markdown

client side config, pip

* feat: markdown

typo in title

* feat: markdown

typo in configuring pip

* feat: markdown

apache like authentication section
an initial cut to view the markdown
in github

* feat: markdown

typo in markdown link

* feat: markdown

remove trailing colon

* feat: markdown

typo in shell markdown

* feat: markdown

standardize on 4 space indent in shell code block

* feat: markdown

complete markdown for section up to alternate installation methods

* feat: markdown

add more of the contents to test with

* feat: markdown

contents

* feat: markdown

contents

* feat: markdown

contents

* feat: markdown
dquote>
dquote> recipes

* feat: markdown
dquote>
dquote> recipes

* feat: markdown
dquote>
dquote> up to licensing

* feat: markdown
dquote>
dquote> contents

* Update README.md

Missing exclamation mark

* Update README.md

missing link

* Update README.md

remove duplicated text

* Update README.md

bold differences it Table of contents

* Update README.md

additional bold changes in table of contents

* Update README.md

broken link

* Update README.md

typo in link fix

* Update README.md

change code block to text as shell highlighting was showing some items in red

* Update README.md

code block shell to text

* Update README.md

correct pypi-server update section

* feat: markdown
dquote>
dquote> link back to TOC title

* Update README.md

change link to TOC title

* Update README.md

link test

* Update README.md

link update

* Update README.md

link update

* Update README.md

link update

* feat: markdown

links

* Update README.md

change the level of indent for uploading packages remotely

* Update README.md

add link to python-pam

* feat: markdown

apache link to TOC not working.

* Update README.md

grammar

* Update README.md

typo bold

* feat: markdown

undo bolded text in TOC and titles as linking does
not work

* feat: markdown

remove bold from TOC

* feat: feature

more link issues

* feat: markdown

fixing broken links

* feat: markdown

change text slightly as markdown only links to plain text

* feat: markdown

typo

* feat: markdown

more link typos

* Update README.md

typo in link

* Update README.md

link will not work with braces in the titles

* feat: markdown

run mdformat and apply changes, :) lint!

* feat:  markdown

- check via mdformat
- remove old check script
- update test-requirements.txt

* feat: markdown

correct the errors in the mdformat run command

* feat: markdown

for testing remove all the actual jobs

* feat: markdown

re-run mdformat

* feat: markdown

put the jobs back in after testing the mdformat
cmd for passing and failing via workflow dispatch

* feat: markdown

remove references to README.md

* feat: markdown

change action to workflow dispatch for testing

* feat: markdown

- update docker igore
- alter unit test to look for version number after md changes

* feat: markdown

black linting

* feat: markdown

update comments

* feat: markdown

update bumpver to look at md rather than rst file

* feat: markdown

replace workflow dispatch with pull request
to get ready for the final PR

* feat: markdown-delete-original

delete the original rst file

* feat: markdown-delete-original

change ci to workflow dispatch for testing

* feat: markdown-delete-original

revert workflow dispatch

* feat: markdown-badge-links

set the links back to the original
URLs.

* feat: markdown-badge-links

fix brackets

* feat: markdown

update the version and date

* feat: markdown conversion

markdown changes to conform to mdformat tooling.
2023-08-15 11:16:30 +02:00
..
.gitignore Download git-new-workdir for STANDALONE. 2015-09-14 18:47:33 +02:00
bumpver.py Feature/markdown conversion (#503) 2023-08-15 11:16:30 +02:00
ci_helper.py Push to Docker Hub from CI (#375) 2021-02-07 20:24:33 -06:00
package.sh fix package script usage 2022-05-01 22:36:06 +02:00
README.rst Feature/markdown conversion (#503) 2023-08-15 11:16:30 +02:00
update_changelog.sh chore(release-candidate-from-github-actions): add github action for release management (#417) 2022-03-25 19:31:39 +01:00

====================
Build scripts folder
====================


Files:
======

- ``bumpver.py``             : Bump, commit and tag new project versions
- ``check_readme.sh``        : Check that README has no RsT-syntactic errors.
- ``package.sh``             : Build deployable artifact (wheel) in ``/dist/`` folder.
- ``README.rst``             : This file.


Release check-list:
===================
1. Update ``/CHANGES.rst`` (+ Title + Date) & ``/README.md`` (Date,
   not version).

2. Push to GitHub to run all TCs once more.

3. Bump version: commit & tag it with ``/bin/bumpver.py``.
   Use ``--help``.
   Read `PEP-440 <https://www.python.org/dev/peps/pep-0440/>`_ to decide the version.

4. Push it in GitHub with ``--follow-tags``.

5. Generate package *wheel* with ``/bin/package.sh``.

6. Upload to PyPi with ``twine upload -s -i <gpg-user> dist/*``

7. Ensure that the new tag is built on hub.docker.com as ``latest`` and as a
   direct tag reference.

8. Copy release notes from ``/CHANGES.rst`` in GitHub as new *"release"* page
   on the new tag.  Check syntactic differences between ``.md`` and ``.rst`` files.