Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New docs and automation, more modernization #19

Merged
merged 12 commits into from
Sep 20, 2022

Conversation

sarnold
Copy link

@sarnold sarnold commented Sep 15, 2022

This is a combination of modernization/cleanup and new/updated tox and Github workflows:

  • remove static package version, use versioningit build depend to create/manage _version.py
  • remove deprecated test driver, use pytest instead
  • remove archaic doc processing/deps, use sphinx api-doc instead
  • convert readme/todo to .rst and add new .rst changelog
  • cleanup imports/packaging and tool configs
  • cleanup workflows, add docs publishing to gh-pages branch (enable deployment in repo settings)
  • add pylint badge workflow, restrict coverage PR comments to "repo owner"
  • add pypi publish step to release workflow (setup API token and then uncomment pubish step)
  • after PR merge, uncomment docs-lint in sphinx workflow

* update/simplify setup and packaging files, migrate tool configs
* add versioningit to build deps, update __init__.py
* remove readme doc processing, prep for readme conversion
* global import cleanup, add isort tox cmd
* update .pre-commit-config.yaml and coverage.yml

Signed-off-by: Stephen L Arnold <[email protected]>
* add new tox commands for 'docs' and 'docs-lint'
* cleanup link errors found by docs-lint
* add sphinx doc build workflow, update ci workflow
* remove new version var from __init__.py globals

Signed-off-by: Stephen L Arnold <[email protected]>
* add pylint badge workflow and update readme (docs-lint will fail
  until badge is created on PR merge)

Signed-off-by: Stephen L Arnold <[email protected]>
* docs-lint will not pass without the link to pylint badge
  (which does not yet exist upstream)

Signed-off-by: Stephen L Arnold <[email protected]>
* update conda recipe, needs version dep in host and run
* cleanup setup.cfg and manifest files

Signed-off-by: Stephen L Arnold <[email protected]>
* work-around for import error in github project source dir

Signed-off-by: Stephen L Arnold <[email protected]>
* pypi action step is not fully enabled yet, requires setup
* check pre-release packaging artifacts for sdist/bdist
* start capturing rst CHANGES file from v0.6.0 onwards

Signed-off-by: Stephen L Arnold <[email protected]>
* create changes file: gitchangelog v0.6.0.. > CHANGELOG.rst
* edit top line in CHANGELOG.rst using current date/new tag
* edit conda/meta.yaml using new tag, then tag this commit

Signed-off-by: Stephen L Arnold <[email protected]>
* using release workflow to publish pypi packages needs first-time setup
* first see the upstream readme for how to setup the token secret
* then uncomment the publish step in release.yml and commit
  https://github.com/pypa/gh-action-pypi-publish
* finally push a tag and wait....

Signed-off-by: Stephen L Arnold <[email protected]>
@bakert bakert merged commit 4498b36 into PennyDreadfulMTG:master Sep 20, 2022
@sarnold sarnold deleted the auto-docs branch October 23, 2022 01:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants