Skip to content

[ENH] Switch datman's CI config to github actions + update package configuration#335

Merged
DESm1th merged 30 commits intoTIGRLab:mainfrom
DESm1th:config_updates
Oct 6, 2022
Merged

[ENH] Switch datman's CI config to github actions + update package configuration#335
DESm1th merged 30 commits intoTIGRLab:mainfrom
DESm1th:config_updates

Conversation

@DESm1th
Copy link
Copy Markdown
Contributor

@DESm1th DESm1th commented Sep 19, 2022

This pull request updates our CI pipelines to use github actions instead of circleci. It also cleans up our existing configuration to remove some clutter.

  • Add github actions workflows that:
    • Automatically label pull requests, and comment on malformed PR titles (this is used later for automated changelogs) (3567059)
    • Automatically run tests against python 3.8, 3.9 and 3.10 and post test coverage comment on PR (dea9f51)
    • Automatically generate and publish docs to our site (83fb207)
    • Automatically generate a release when tags are pushed (generates a changelog, adds changelog to release notes on github, updates zenodo creators list order, and pushes to test-pypi and then pypi) (59c3025)
  • Refactor the Dockerfile to speed up builds (74d0d2f)
  • Move all project configuration into pyproject.toml, and remove setup.py and setup.cfg (b7ea1a0, 35faa86, dbd93f1)
  • Use new importlib.metadata package to version package from git tags, remove versioneer (a27b97d)
  • Fix some docs config/build issues
    • Remove docs/requirements.txt file (is now contained in optional dependencies in pyproject.toml) (41a33f1)
    • Move README.rst to the docs folder (3f0b31b)
    • Fix build issue from certain links being declared as having duplicate names (7b373d7)
    • Remove versioneer references from docs/conf.py (4eb0721)
  • Update zenodo configuration (8896a94, 9a0ccb2)
    • Fix format error in .zenodo.json contributors entries
    • Remove .maintenance folder and move update_zenodo.py to .github folder
    • Add some missing creators
    • Modify update_zenodo.py to use git-summary --line instead of now removed git-line-summary tool
  • Remove old/unused config files, remove versioneer from manifest.in, rename CHANGES.rst to CHANGELOG.md (name change needed by a github action) (5887bb0)
  • Tweak auto-assign config to always assign me and randomly choose two others, and to use the github action instead of the old bot (which has sporadically and mysteriously broken on us) (85997ed)
  • Adds tests, coverage and zenodo badges to our readme (717df18)
  • Updates contributions guidelines, moves the file to our docs, updates link references to it (b6a343b)

- Unpinned the ubuntu:focal version, since we dont need that much
  specificity
- Set the pythonpath explicitly, for tests and such
- Get datman with the copy command instead
- Install datman + dependencies last to avoid rebuilding whole
  container when changes occur
- Add missing 'type' field to contributor entries
- Add missing creators
- Remove .maintenance folder
- Move the update_zenodo.py script to the .github folder
- Changelog updates based on merged PRs + their labels
- Zenodo creator list is reorganized based on line contributions
- Build is pushed to test-pypi and then pypi, if earlier steps
  succeed
- Change CONTRIBUTION.md to rst format
- Move contributing.rst to the docs folder
- Update the newPRBot comment to point to the rendered website
  page.
- Add pylint to style optional dependencies
@DESm1th DESm1th requested review from jerdra and josephmje September 19, 2022 18:57
@DESm1th DESm1th self-assigned this Sep 19, 2022
@auto-assign auto-assign bot requested a review from benselby September 19, 2022 18:57
@DESm1th
Copy link
Copy Markdown
Contributor Author

DESm1th commented Sep 19, 2022

The 'add a label' and 'tests' check failures are, I believe, because it's trying to use my credentials to run things owned by tigrlab. They should run properly once the PR is merged.

@TIGRLab TIGRLab deleted a comment from allcontributors bot Sep 19, 2022
@DESm1th
Copy link
Copy Markdown
Contributor Author

DESm1th commented Sep 19, 2022

Oh! Also, @jerdra , @josephmje , @salimansourc do you guys want to be added to the maintainer list? If so what email should I throw on?

@all-contributors add @josephmje , @jerdra, @salimansourc for code, maintenance, review

@allcontributors
Copy link
Copy Markdown
Contributor

@DESm1th

I've put up a pull request to add @josephmje! 🎉

@TIGRLab TIGRLab deleted a comment from allcontributors bot Sep 19, 2022
@DESm1th
Copy link
Copy Markdown
Contributor Author

DESm1th commented Sep 19, 2022

@all-contributors add @jerdra for code, maintenance, review

@allcontributors
Copy link
Copy Markdown
Contributor

@DESm1th

I've put up a pull request to add @jerdra! 🎉

@DESm1th
Copy link
Copy Markdown
Contributor Author

DESm1th commented Sep 19, 2022

@all-contributors add @salimansourc for code, maintenance, review

@allcontributors
Copy link
Copy Markdown
Contributor

@DESm1th

I've put up a pull request to add @salimansourc! 🎉

josephmje
josephmje previously approved these changes Sep 22, 2022
Copy link
Copy Markdown
Contributor

@josephmje josephmje left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this @DESm1th! Excited about the new Github actions you've added here, this automates so much!

I just left a few very minor comments

Comment thread .github/comment_pr_title/action.yml Outdated
Comment thread .github/auto_assign.yml
Comment thread .github/labeler.yml Outdated
Co-authored-by: Michael Joseph <josephmje.22@gmail.com>
@DESm1th
Copy link
Copy Markdown
Contributor Author

DESm1th commented Sep 22, 2022

@all-contributors add @slimnsour for code, maintenance, review

@allcontributors
Copy link
Copy Markdown
Contributor

@DESm1th

I've put up a pull request to add @slimnsour! 🎉

@DESm1th DESm1th merged commit 32d9b6c into TIGRLab:main Oct 6, 2022
@DESm1th DESm1th deleted the config_updates branch October 6, 2022 18:14
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