Skip to content

Add "v2" readthedocs setup & modernize CI #38

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jun 14, 2023
Merged

Add "v2" readthedocs setup & modernize CI #38

merged 2 commits into from
Jun 14, 2023

Conversation

@jepler
Copy link
Collaborator

@jepler jepler commented May 31, 2023

@jepler jepler changed the title Add "v2" readthedocs setup Add "v2" readthedocs setup & modernize CI May 31, 2023
tekktrik
tekktrik requested changes May 31, 2023
View reviewed changes
Copy link

@tekktrik tekktrik left a comment

Choose a reason for hiding this comment

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

You may need to move metadata from setup.py to pyproject.toml for the release CI to work, but the fact you have essentially a stub may be enough. Since your setup.py doesn't implement any extensions or anything, it's totally feasible to move it all into pyproject.toml.

.github/workflows/release_gh.yml
uses: adafruit/workflows-circuitpython-libs/release-gh@main
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
upload-url: ${{ github.event.release.upload_url }}
Copy link

@tekktrik tekktrik May 31, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

I believe you'll need to the additional argument here since it's a package that doesn't start with adafruit_:

Suggested change
upload-url: ${{ github.event.release.upload_url }}
upload-url: ${{ github.event.release.upload_url }}
package-prefix: jepler_udecimal

@tekktrik
Copy link

tekktrik commented May 31, 2023

Yeah, looking at the CI, the setup.py comment seems to be optional - it's building the source and binary distributions just fine!

tekktrik
tekktrik approved these changes Jun 1, 2023
View reviewed changes
Copy link

@tekktrik tekktrik left a comment

Choose a reason for hiding this comment

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

Should be everything!

@jepler jepler merged commit 39bdd73 into main Jun 14, 2023
adafruit-adabot added a commit to adafruit/CircuitPython_Community_Bundle that referenced this pull request Jun 15, 2023
@adafruit-adabot
Automated update by Adabot (adafruit/adabot@b417f43)
f9213a1 
Updating https://github.com/todbot/CircuitPython_PS2Controller to 1.2.1 from 1.2.0:
  > fix data shift timing, fixes "last bit error" aka "SQUARE not registering" as reported by @jedgarpark

Updating https://github.com/furbrain/CircuitPython_distox to 1.0.0 from 0.9.0:
  > Make it work on github actions, again
  > Make it work on github actions
  > Fix bugs and add "protocol service"
  > Fix documentation

Updating https://github.com/jepler/Jepler_CircuitPython_udecimal to 1.0.7 from 1.0.6:
  > tweak secrets in release process
  > Merge pull request circuitpython/Jepler_CircuitPython_udecimal#38 from jepler/readthedocs-v2
  > Merge pull request circuitpython/Jepler_CircuitPython_udecimal#36 from jepler/pre-commit-ci-update-config
  > Merge pull request circuitpython/Jepler_CircuitPython_udecimal#35 from jepler/pre-commit-ci-update-config
  > Merge pull request circuitpython/Jepler_CircuitPython_udecimal#34 from jepler/pre-commit-ci-update-config
  > Merge pull request circuitpython/Jepler_CircuitPython_udecimal#32 from jepler/use-buildsh
  > Merge pull request circuitpython/Jepler_CircuitPython_udecimal#31 from jepler/pre-commit-ci-update-config
  > Merge pull request circuitpython/Jepler_CircuitPython_udecimal#30 from jepler/pre-commit-ci-update-config
  > Merge pull request circuitpython/Jepler_CircuitPython_udecimal#29 from jepler/pre-commit-ci-update-config
  > Merge pull request circuitpython/Jepler_CircuitPython_udecimal#28 from jepler/pre-commit-ci-update-config
  > Merge pull request circuitpython/Jepler_CircuitPython_udecimal#27 from jepler/pre-commit-ci-update-config
  > Merge pull request circuitpython/Jepler_CircuitPython_udecimal#26 from jepler/pre-commit-ci-update-config
  > Merge pull request circuitpython/Jepler_CircuitPython_udecimal#25 from jepler/pre-commit-ci-update-config
  > Merge pull request circuitpython/Jepler_CircuitPython_udecimal#24 from jepler/pre-commit-ci-update-config
  > Merge pull request circuitpython/Jepler_CircuitPython_udecimal#22 from jepler/pre-commit-ci-update-config
  > Merge pull request circuitpython/Jepler_CircuitPython_udecimal#23 from jepler/fix-ci-tags
  > Merge pull request circuitpython/Jepler_CircuitPython_udecimal#21 from jepler/pre-commit-ci-update-config
  > Merge pull request circuitpython/Jepler_CircuitPython_udecimal#20 from jepler/pre-commit-ci-update-config
  > Merge pull request circuitpython/Jepler_CircuitPython_udecimal#19 from jepler/pre-commit-ci-update-config
  > Merge pull request circuitpython/Jepler_CircuitPython_udecimal#18 from jepler/pre-commit-ci-update-config
  > Merge pull request circuitpython/Jepler_CircuitPython_udecimal#17 from jepler/pre-commit-ci-update-config
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tekktrik tekktrik tekktrik approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jepler @tekktrik